chore: initial commit
This commit is contained in:
0
docs/source/_static/.gitkeep
Normal file
0
docs/source/_static/.gitkeep
Normal file
3
docs/source/changelog.md
Normal file
3
docs/source/changelog.md
Normal file
@@ -0,0 +1,3 @@
|
||||
```{include} ../../CHANGELOG.md
|
||||
|
||||
```
|
||||
56
docs/source/conf.py
Normal file
56
docs/source/conf.py
Normal file
@@ -0,0 +1,56 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = "dbus-fast"
|
||||
copyright = "2020, Bluetooth Devices Authors"
|
||||
author = "Bluetooth Devices Authors"
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
"myst_parser",
|
||||
]
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = [".rst", ".md"]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ["_templates"]
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = []
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ["_static"]
|
||||
3
docs/source/contributing.md
Normal file
3
docs/source/contributing.md
Normal file
@@ -0,0 +1,3 @@
|
||||
```{include} ../../CONTRIBUTING.md
|
||||
|
||||
```
|
||||
21
docs/source/index.md
Normal file
21
docs/source/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Welcome to dbus-fast documentation!
|
||||
|
||||
```{toctree}
|
||||
:caption: Installation & Usage
|
||||
:maxdepth: 2
|
||||
|
||||
installation
|
||||
usage
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Project Info
|
||||
:maxdepth: 2
|
||||
|
||||
changelog
|
||||
contributing
|
||||
```
|
||||
|
||||
```{include} ../../README.md
|
||||
|
||||
```
|
||||
7
docs/source/installation.md
Normal file
7
docs/source/installation.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Installation
|
||||
|
||||
The package is published on [PyPI](https://pypi.org/project/deezer-python/) and can be installed with `pip` (or any equivalent):
|
||||
|
||||
```bash
|
||||
pip install dbus-fast
|
||||
```
|
||||
9
docs/source/usage.md
Normal file
9
docs/source/usage.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Usage
|
||||
|
||||
To use this package, import it:
|
||||
|
||||
```python
|
||||
import dbus_fast
|
||||
```
|
||||
|
||||
TODO: Document usage
|
||||
Reference in New Issue
Block a user