diff options
| author | sommersoft <sommersoft@users.noreply.github.com> | 2021-01-07 22:26:59 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-07 22:26:59 +0300 |
| commit | fb8cd063ebed6263e29dcbee2c7857d0dd069125 (patch) | |
| tree | 3cd19c6e9df530ba72037afa541f7425345b9c0c /acme | |
| parent | e602736bdad1e49ddc80f5d431372e3b19b73388 (diff) | |
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
Diffstat (limited to 'acme')
| -rw-r--r-- | acme/acme/challenges.py | 2 | ||||
| -rw-r--r-- | acme/acme/errors.py | 2 | ||||
| -rw-r--r-- | acme/acme/messages.py | 4 | ||||
| -rw-r--r-- | acme/docs/conf.py | 5 |
4 files changed, 8 insertions, 5 deletions
diff --git a/acme/acme/challenges.py b/acme/acme/challenges.py index b9c6b7eb2..376e9a382 100644 --- a/acme/acme/challenges.py +++ b/acme/acme/challenges.py @@ -150,7 +150,7 @@ class KeyAuthorizationChallenge(_TokenChallenge): """Challenge based on Key Authorization. :param response_cls: Subclass of `KeyAuthorizationChallengeResponse` - that will be used to generate `response`. + that will be used to generate ``response``. :param str typ: type of the challenge """ typ = NotImplemented diff --git a/acme/acme/errors.py b/acme/acme/errors.py index 806657940..5ca5a4fa2 100644 --- a/acme/acme/errors.py +++ b/acme/acme/errors.py @@ -49,7 +49,7 @@ class MissingNonce(NonceError): Replay-Nonce header field in each successful response to a POST it provides to a client (...)". - :ivar requests.Response response: HTTP Response + :ivar requests.Response ~.response: HTTP Response """ def __init__(self, response, *args, **kwargs): diff --git a/acme/acme/messages.py b/acme/acme/messages.py index 6325ed57f..3a505843d 100644 --- a/acme/acme/messages.py +++ b/acme/acme/messages.py @@ -275,7 +275,7 @@ class Resource(jose.JSONObjectWithFields): class ResourceWithURI(Resource): """ACME Resource with URI. - :ivar unicode uri: Location of the resource. + :ivar unicode ~.uri: Location of the resource. """ uri = jose.Field('uri') # no ChallengeResource.uri @@ -627,7 +627,7 @@ class Order(ResourceBody): :ivar str finalize: URL to POST to to request issuance once all authorizations have "valid" status. :ivar datetime.datetime expires: When the order expires. - :ivar .Error error: Any error that occurred during finalization, if applicable. + :ivar ~.Error error: Any error that occurred during finalization, if applicable. """ identifiers = jose.Field('identifiers', omitempty=True) status = jose.Field('status', decoder=Status.from_json, diff --git a/acme/docs/conf.py b/acme/docs/conf.py index d3e7be371..9d3c4d05c 100644 --- a/acme/docs/conf.py +++ b/acme/docs/conf.py @@ -85,7 +85,10 @@ language = 'en' # 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/*' +] # The reST default role (used for this markup: `text`) to use for all # documents. |