Include contributing page to the docs (#4144)

* Add MyST parser

* Include contributing page to the docs
This commit is contained in:
Bruno Alla 2023-03-04 18:45:25 +00:00 committed by GitHub
parent b5a043551d
commit 6e782bff33
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 7 additions and 2 deletions

View File

@ -23,13 +23,13 @@ now = datetime.now()
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [] extensions = ["myst_parser"]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"] templates_path = ["_templates"]
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = ".rst" source_suffix = [".rst", ".md"]
# The encoding of source files. # The encoding of source files.
# source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'

3
docs/contributing.md Normal file
View File

@ -0,0 +1,3 @@
```{include} ../CONTRIBUTING.md
```

View File

@ -27,6 +27,7 @@ Contents
websocket websocket
faq faq
troubleshooting troubleshooting
contributing
Indices and tables Indices and tables
------------------ ------------------

View File

@ -1,2 +1,3 @@
sphinx==6.1.3 sphinx==6.1.3
sphinx-rtd-theme==1.2.0 sphinx-rtd-theme==1.2.0
myst-parser==0.19.0