File tree 2 files changed +37
-0
lines changed
2 files changed +37
-0
lines changed Original file line number Diff line number Diff line change
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. [ Read
29
+ the docs] [ MyST docs ] to learn more on how to use it.
30
+
31
+
32
+ [ MyST docs] :
33
+ https://myst-parser.rtfd.io/en/latest/sphinx/intro.html#write-your-first-markdown-document
34
+ [ MyST parser ] : https://pypi.org/project/myst-parser/
35
+ [ Read The Docs ] : https://readthedocs.org
36
+ [ Sphinx ] : https://www.sphinx-doc.org
Original file line number Diff line number Diff line change @@ -36,6 +36,7 @@ Glossary <glossary>
36
36
:hidden:
37
37
38
38
Code Of Conduct <contributing/code_of_conduct>
39
+ contributing/guidelines
39
40
contributing/security
40
41
Private unsupported (dev) API autodoc <pkg/modules>
41
42
```
You can’t perform that action at this time.
0 commit comments