Commit Graph

18 Commits

Author SHA1 Message Date
Pradyun Gedam fb03b6aede
Switch to sphinx-inline-tabs for tabs 2020-10-18 22:42:24 +05:30
Sviatoslav Sydorenko 13962cd6ad
🎨 Colorize the "important" admonition blocks 2020-09-25 23:25:36 +02:00
Sviatoslav Sydorenko 3301284810
📝 Add initial sphinx ext for per-doc feedbacks
Resolves #8783
2020-09-25 23:25:35 +02:00
shireenrao 8f3151324f fix inconsistent indentation of tab blocks 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati c36bd748f3 fix tox.ini and conf.py to use sphinx_tabs_nowarn 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati 28f3f2cd2c ignore sphinx-tab extension for man builds 2020-09-13 20:47:16 -04:00
Srinivas Nyayapati 119d8666b4 implement sphinx-tabs on installing page of docs 2020-09-13 20:47:16 -04:00
Srinivas Nyayapati 4e34f6530a add theme config to set background color and text color for code-blocks 2020-08-20 12:24:58 -04:00
Reece Dunham e093938d15 Bump year
Signed-off-by: Reece Dunham <me@rdil.rocks>
2020-02-21 22:50:46 +00:00
Chris Hunt c9ab34a945 Fix docs build on Windows
Sphinx expects the "document name" field to be normalized with respect
to slashes (all /), so we now do this in a portable way for Windows.
2019-12-28 18:21:46 -05:00
Remi Rampin 04d8841ace Update links in docs 2019-12-11 22:23:34 +01:00
Xavier Fernandez 8f45aee97a Fix line length & don't flake8 docs in python 2 2019-07-18 14:37:31 +02:00
Eli Schwartz 1350b95dee
docs: fix manpage generation
This was broken in commit 20f672c4e6,
which reorganized the conf.py file into the html subdirectory. See:
https://github.com/pypa/pip/pull/5724
https://github.com/readthedocs/readthedocs.org/issues/1543

This broke the relative manpage globbing because Sphinx will os.chdir()
into the directory location of conf.py before evaluating it, so the
globbing returned nothing at all. As a result, while the main pip(1)
manpage continued to be built, no pip-*(1) subcommand manpages were
built.
2019-07-17 23:53:50 -04:00
Eli Schwartz f2cbcd190f
docs: check that the subcommand manpages are actually found and being used 2019-07-17 23:52:44 -04:00
Eli Schwartz f3f63c0f82
docs: fix manpage names being truncated
In commit d2e7377c0f, the documentation
directories were reorganized, resulting in `fname_base` (the path that
Sphinx looked for source files) to no longer expect the leading 'man/'.
This was always also stripped from the `outname`, which now strips four
characters twice over.

Fix by reducing the stripped length to only the length of the prefix in
fname_base itself.
2019-07-17 22:53:17 -04:00
Albert Tugushev 7130b1d0e0 Fix option name for smart quotes in sphinxdoc conf (#6422)
Also configure the smartquotes_action to exclude dashes from transformation.
See https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smartquotes
2019-04-21 09:51:42 -07:00
Pi Delport 5f3c56e188 Fix some typos 2019-03-12 21:54:18 +01:00
Pradyun Gedam 20f672c4e6
Move conf.py into the html directory, to be compatible with RTD
Also add a small comment explaining why this has been done.
2018-08-22 16:33:16 +05:30
Renamed from docs/conf.py (Browse further)