Skip to content

Commit

Permalink
Include contributing guidelines in Sphinx docs (#771)
Browse files Browse the repository at this point in the history
  • Loading branch information
webknjaz authored Nov 22, 2021
1 parent 8fdddfd commit 1a3331e
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@
# -- Options for intersphinx extension ---------------------------------------

intersphinx_mapping = {
'myst': ('https://myst-parser.rtfd.io/en/latest', None),
'python': ('https://docs.python.org/3', None),
'python2': ('https://docs.python.org/2', None),
}
Expand Down
34 changes: 34 additions & 0 deletions docs/contributing/guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
```{spelling}
de
facto
Pre
reStructuredText
```

```{include} ../../CONTRIBUTING.md
```

# Contributing docs

We use [Sphinx] to generate our docs website. You can trigger
the process locally by executing:

```shell-session
$ tox -e build-docs
```

It is also integrated with [Read The Docs] that builds and
publishes each commit to the main branch and generates live
docs previews for each pull request.

The sources of the [Sphinx] documents use reStructuredText as a
de-facto standard. But in order to make contributing docs more
beginner-friendly, we have integrated [MyST parser] allowing us
to also accept new documents written in an extended version of
Markdown that supports using Sphinx directives and roles. {ref}`Read
the docs <myst:intro/writing>` to learn more on how to use it.


[MyST parser]: https://pypi.org/project/myst-parser/
[Read The Docs]: https://readthedocs.org
[Sphinx]: https://www.sphinx-doc.org
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Glossary <glossary>
:hidden:
Code Of Conduct <contributing/code_of_conduct>
contributing/guidelines
contributing/security
Private unsupported (dev) API autodoc <pkg/modules>
```

0 comments on commit 1a3331e

Please sign in to comment.