mirror of
https://github.com/certbot/certbot.git
synced 2025-08-06 16:42:41 +03:00
579b39dce1
* update quickstart and remove os import * simplify theme use * list sphinx_rtd_theme as extension Our docs builds failed last night, presumably because #9754 updated `sphinx_rtd_theme` which changed some unknown thing. Looking into it, our usage of this project was very unconventional. Following the code comment I deleted in this PR to https://docs.readthedocs.io/en/stable/faq.html#i-want-to-use-the-read-the-docs-theme-locally, simple instructions are given to put the following in your `conf.py` file: ``` extensions = [ ... 'sphinx_rtd_theme', ] html_theme = "sphinx_rtd_theme" ``` I did this instead of the more complicated logic we were using and all builds passed locally. I also triggered a build on readthedocs with these changes which also passed.
34 lines
1.8 KiB
Bash
Executable File
34 lines
1.8 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
if [ $# -ne 1 ]; then
|
|
echo "Usage: $(basename $0) project-name"
|
|
exit 1
|
|
fi
|
|
|
|
PROJECT=$1
|
|
|
|
yes "n" | sphinx-quickstart --dot _ --project $PROJECT --author "Certbot Project" -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --extensions sphinx_rtd_theme --makefile --batchfile $PROJECT/docs
|
|
|
|
cd $PROJECT/docs
|
|
sed -i -e "s|\# needs_sphinx = '1.0'|needs_sphinx = '1.0'|" conf.py
|
|
sed -i -e "s|intersphinx_mapping = {'https://docs.python.org/': None}|intersphinx_mapping = {\n 'python': ('https://docs.python.org/', None),\n 'acme': ('https://acme-python.readthedocs.org/en/latest/', None),\n 'certbot': ('https://eff-certbot.readthedocs.io/en/stable/', None),\n}|" conf.py
|
|
sed -i -e "s|html_theme = 'alabaster'|html_theme = 'sphinx_rtd_theme'|" conf.py
|
|
sed -i -e "s|# Add any paths that contain templates here, relative to this directory.|autodoc_member_order = 'bysource'\nautodoc_default_flags = ['show-inheritance']\n\n# Add any paths that contain templates here, relative to this directory.|" conf.py
|
|
sed -i -e "s|# The name of the Pygments (syntax highlighting) style to use.|default_role = 'py:obj'\n\n# The name of the Pygments (syntax highlighting) style to use.|" conf.py
|
|
# If the --ext-todo flag is removed from sphinx-quickstart, the line below can be removed.
|
|
sed -i -e "s|todo_include_todos = True|todo_include_todos = False|" conf.py
|
|
echo "/_build/" >> .gitignore
|
|
echo "=================
|
|
API Documentation
|
|
=================
|
|
|
|
.. toctree::
|
|
:glob:
|
|
|
|
api/**" > api.rst
|
|
sed -i -e "s| :caption: Contents:| :caption: Contents:\n\n.. automodule:: ${PROJECT//-/_}\n :members:\n\n.. toctree::\n :maxdepth: 1\n\n api|" index.rst
|
|
|
|
echo "Suggested next steps:
|
|
* Add API docs to: $PROJECT/docs/api/
|
|
* Run: git add $PROJECT/docs"
|