pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-08 22:04:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add documentation ... for writing documentation

Browse source
This commit is contained in:
Ian Cordasco 2016-06-20 09:26:01 -05:00
parent 41277ff965
commit 3e8bbc50dc
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
3 changed files with 188 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/source/internal/contributing.rst
View file

@ -93,8 +93,10 @@ Contributing Documentation
==========================
To contribute to |Flake8|'s documentation, you might want to first read a
little about reStructuredText or Sphinx. For the most part, you should be fine
following the structure and style of the rest of |Flake8|'s documentation.
little about reStructuredText or Sphinx. |Flake8| has a :ref:`guide of best
practices <docs-style>` when contributing to our documentation. For the most
part, you should be fine following the structure and style of the rest of
|Flake8|'s documentation.
All of |Flake8|'s documentation is written in reStructuredText and rendered by
Sphinx. The source (reStructuredText) lives in ``docs/source/``. To build