Skip to content
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.

Sign up for GitHub

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

Jump to bottom

update(docguides): add rst-format rules description #77

Merged
merged 1 commit into from
Dec 6, 2023
Merged

update(docguides): add rst-format rules description #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions source/development/doc_guidelines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,16 @@ To run the `doc8 <https://github.com/PyCQA/doc8>`_ format checker:

make rst-format

Besides checking for invalid reST format styles (D000 rule), the ``rst-format`` also checks
for:

.. note::
- lines longer than 99 characters - D001
- no trailing whitespace - D002
- no tabulation for indentation - D003
- no carriage returns (use unix newlines) - D004
- no newline at end of file - D005

**Spelling Dictionaries**

The spell checker uses standard enchant dictionaries to validate words. However, some specific
Expand Down
1 change: 1 addition & 0 deletions source/spelling_wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,4 @@ Submodules
subdirectory
scalability
codebase
unix
Loading