Skip to content

Commit 01dfe96

Browse files
committed
Include contributing guidelines in Sphinx docs
1 parent 8fdddfd commit 01dfe96

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@
159159
# -- Options for intersphinx extension ---------------------------------------
160160

161161
intersphinx_mapping = {
162+
'myst': ('https://myst-parser.rtfd.io/en/latest', None),
162163
'python': ('https://docs.python.org/3', None),
163164
'python2': ('https://docs.python.org/2', None),
164165
}

docs/contributing/guidelines.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
```{spelling}
2+
de
3+
facto
4+
Pre
5+
reStructuredText
6+
```
7+
8+
```{include} ../../CONTRIBUTING.md
9+
```
10+
11+
# Contributing docs
12+
13+
We use [Sphinx] to generate our docs website. You can trigger
14+
the process locally by executing:
15+
16+
```shell-session
17+
$ tox -e build-docs
18+
```
19+
20+
It is also integrated with [Read The Docs] that builds and
21+
publishes each commit to the main branch and generates live
22+
docs previews for each pull request.
23+
24+
The sources of the [Sphinx] documents use reStructuredText as a
25+
de-facto standard. But in order to make contributing docs more
26+
beginner-friendly, we have integrated [MyST parser] allowing us
27+
to also accept new documents written in an extended version of
28+
Markdown that supports using Sphinx directives and roles. {ref}`Read
29+
the docs <myst:intro/writing>` to learn more on how to use it.
30+
31+
32+
[MyST parser]: https://pypi.org/project/myst-parser/
33+
[Read The Docs]: https://readthedocs.org
34+
[Sphinx]: https://www.sphinx-doc.org

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Glossary <glossary>
3636
:hidden:
3737
3838
Code Of Conduct <contributing/code_of_conduct>
39+
contributing/guidelines
3940
contributing/security
4041
Private unsupported (dev) API autodoc <pkg/modules>
4142
```

0 commit comments

Comments
 (0)