Automatically Catch Sphinx Errors (#8530)

* clean up some Sphinx warnings

* first attempt at a doc-test pipeline job

* fix formatting

* fix test name

* set env for bash

* try bash vs script

* maybe it didn't like me setting 'PATH'...derp

* drop use of venv

* sphinx-build isn't a py script

* try activating venv

* docs: remove unused html_static tags

* clean up final sphinx build errors for certbot

* clean up final sphinx build errors for acme

* better names for docs pipeline

* fix spelling

* add docs_extras to setup.py

* remove temp doc-testing pipeline; add template to main.yml

* rearrange pipeline execution; run sphinx builds in one job

* add documentation note to compat.os

* add uninstall.rst as a sub-toctree to avoid build error
This commit is contained in:
sommersoft
2021-01-07 20:26:59 +01:00
committed by GitHub
parent e602736bda
commit fb8cd063eb
29 changed files with 82 additions and 28 deletions
+1 -3
View File
@@ -2,6 +2,4 @@ certbot.compat.os module
========================
.. automodule:: certbot.compat.os
:members:
:undoc-members:
:show-inheritance:
:members: chmod, umask, chown, open, mkdir, makedirs, rename, replace, access, stat, fstat
+6 -1
View File
@@ -95,7 +95,12 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
exclude_patterns = [
'_build',
'man',
'challenges.rst',
'ciphers.rst'
]
# The reST default role (used for this markup: `text`) to use for all
# documents.
+5
View File
@@ -240,6 +240,11 @@ look at the :doc:`packaging`.
Certbot-Auto
------------
.. toctree::
:hidden:
uninstall
We used to have a shell script named ``certbot-auto`` to help people install
Certbot on UNIX operating systems, however, this script is no longer supported.