Viicos
49f52a8598
Update documentation regarding entry points
...
Refer to the PyPA packaging guide
Replace references to the deprecated `pkg_resources` docs
2024-03-14 21:06:23 +01:00
Michał Górny
26d3184ae2
update plugins for sphinx-prompt-1.8.0
...
The sphinx-prompt plugin has renamed its package in 1.8.0 from erraneous
`sphinx-prompt` name to `sphinx_prompt`. Adjust the conf accordingly.
2024-01-05 12:15:40 +01:00
Anthony Sottile
e94fb10940
require python>=3.7
2022-08-05 19:51:08 -04:00
Anthony Sottile
9afcda1286
fix docs build for sphinx 5.x
2022-05-30 18:24:13 -04:00
Anthony Sottile
430f55e6d7
remove manpage
...
the suggestion for packagers is to utilize help2man or similar tools to get an up-to-date manpage
2022-02-10 09:44:04 -05:00
Anthony Sottile
741ff11bfb
use type hints instead of :type and :rtype
2022-01-05 14:09:39 -05:00
Anthony Sottile
e527b8e3ca
simplify our own flake8 config
2021-11-14 08:49:01 -08:00
Anthony Sottile
af1668bf04
extend black formatting to tests as well
2021-04-18 09:23:48 -07:00
Anthony Sottile
fe0e2495ce
fix pr and issue links in release notes
2021-04-03 18:21:02 -07:00
Anthony Sottile
358ae85120
automatic: pyupgrade --py36-plus
2021-03-30 17:37:13 -07:00
Jon Dufresne
3d394b1ab0
Update documentation links to latest Python 3 documentation
...
The URL https://docs.python.org/3/ is actively maintained and updated.
2018-06-10 11:23:28 -07:00
Ian Stapleton Cordasco
69eaa28da2
Update name across the project post-marriage
2017-07-27 18:47:38 -05:00
Ian Cordasco
e380665530
Add a man page for Flake8
...
Document Flake8 for users expecting `man flake8` to work and include the
man page in Flake8's documentation.
Closes #247
2016-11-13 14:40:14 -06:00
Ian Cordasco
cee691059f
Merge branch 'origin/proposed/3.0' into master
2016-06-25 12:01:02 -05:00
Ian Cordasco
57ac6ab699
Add |Flake8| substitution to the epilog
...
The rst_epilog config value in Sphinx allows you to maintain a global
list of replaces or includes that are appended to the text of each
document in your documentation. This allows us to use |Flake8| everywhere
without redefining the replace in every document.
2016-06-20 08:04:33 -05:00
Ian Cordasco
a7898e0389
Begin adding user-facing documentation
...
Especially around invocation and configuration
2016-05-26 13:21:25 -05:00
Ian Cordasco
adaa47730e
Comment html_static_path in sphinx config
2016-05-10 17:26:11 -05:00
Ian Cordasco
938d2c450a
Switch to the RTD theme
2016-01-26 08:40:45 -06:00
Ian Cordasco
7898b5c12e
Add documentation around Option Management
2016-01-25 22:06:14 -06:00
Ian Cordasco
11be73dbbb
Note that we need at least Sphinx 1.3
...
Exclude sphinx conf.py from flake8
2016-01-19 07:27:39 -06:00
Ian Cordasco
e66fc2efa8
Start creating documentation
2016-01-19 07:19:16 -06:00
