mirror of
https://github.com/certbot/certbot.git
synced 2026-02-19 02:28:06 -05:00
9f5451d16b
this hopefully fixes our nightly failures readthedocs seems to redirect users to its .io site so https://acme-python.readthedocs.org/en/latest/objects.inv is supposed to redirect people to https://acme-python.readthedocs.io/en/latest/objects.inv, but that doesn't always seem to work and instead [sometimes serves a 403](https://dev.azure.com/certbot/certbot/_build/results?buildId=8237&view=logs&j=d74e04fe-9740-597d-e9fa-1d0400037dfd&t=dde413a4-f24c-59a0-9684-e33d79f9aa02&l=800) removing the need for this redirect seems to fix things based on some quick testing and certainly shouldn't hurt
33 lines
1.8 KiB
Bash
Executable file
33 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.io/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"
|