-
-
Notifications
You must be signed in to change notification settings - Fork 590
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Include contributing guidelines in Sphinx docs (#771)
- Loading branch information
Showing
3 changed files
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters