Skip to content

Include contributing guidelines in Sphinx docs #771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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>
```