Skip to content

Commit 54bfa6d

Browse files
committed
Updated docs.
1 parent a2544f6 commit 54bfa6d

File tree

5 files changed

+26
-21
lines changed

5 files changed

+26
-21
lines changed

doc-source/codes.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
flake8 codes
33
=================
44

5-
============== ====================================
6-
Code Description
7-
============== ====================================
8-
STRFTIME001 Linux-specific strftime code used
9-
STRFTIME002 Windows-specific strftime code used
10-
============== ====================================
5+
.. flake8-codes:: flake8_strftime
6+
7+
STRFTIME001
8+
STRFTIME002

doc-source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@
4646
'sphinxcontrib.default_values',
4747
'sphinxcontrib.toctree_plus',
4848
'seed_intersphinx_mapping',
49+
'sphinx_toolbox.pre_commit',
50+
'sphinx_toolbox.flake8',
4951
]
5052

5153
sphinxemoji_style = 'twemoji'

doc-source/index.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -127,15 +127,9 @@ Use as a pre-commit hook
127127

128128
See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
129129

130-
Sample `.pre-commit-config.yaml`:
130+
Sample ``.pre-commit-config.yaml``:
131131

132-
.. code-block:: yaml
133-
134-
- repo: https://gitlab.com/pycqa/flake8
135-
rev: 3.8.1
136-
hooks:
137-
- id: flake8
138-
additional_dependencies: [flake8-strftime==0.1.1]
132+
.. pre-commit:flake8:: 0.1.1
139133
140134
141135
.. toctree::
@@ -149,8 +143,14 @@ Sample `.pre-commit-config.yaml`:
149143

150144
codes
151145
API Reference<docs>
146+
147+
148+
.. toctree::
149+
:maxdepth: 3
150+
:caption: Contributing
151+
152+
contributing
152153
Source
153-
Building
154154

155155
.. start links
156156

doc-source/requirements.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
autodocsumm>=0.2.0
2-
default_values>=0.2.0
3-
domdf_sphinx_theme>=0.1.0
4-
extras_require>=0.2.0
5-
seed_intersphinx_mapping>=0.1.1
2+
default-values>=0.2.0
3+
domdf-sphinx-theme>=0.1.0
4+
extras-require>=0.2.0
5+
seed-intersphinx-mapping>=0.1.1
66
sphinx>=3.0.3
77
sphinx-copybutton>=0.2.12
88
sphinx-notfound-page>=0.5
99
sphinx-prompt>=1.1.0
1010
sphinx-tabs>=1.1.13
11-
sphinx-toolbox>=1.5.1
11+
sphinx-toolbox>=1.6.1
1212
sphinxcontrib-httpdomain>=1.7.0
1313
sphinxemoji>=0.1.6
14-
toctree_plus>=0.0.4
14+
toctree-plus>=0.0.4

repo_helper.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,8 @@ classifiers:
3939

4040
exclude_files:
4141
- setup_cfg
42+
43+
44+
extra_sphinx_extensions:
45+
- sphinx_toolbox.pre_commit
46+
- sphinx_toolbox.flake8

0 commit comments

Comments
 (0)