Skip to content

Treat Sphinx doc build warnings as errors. #8033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bneradt merged 1 commit into from
Jul 2, 2021
Merged

Treat Sphinx doc build warnings as errors. #8033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ endif # BUILD_MANPAGES
# see https://media.readthedocs.org/pdf/sphinx/1.6.3/sphinx.pdf
# section 24.3.2 around page 247, third item for 'NotImplementedError', so this is kind of useless.

ALLSPHINXOPTS = $(SPHINXOPTS)
ALLSPHINXOPTS = $(SPHINXOPTS) -W
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(SPHINXOPTS)

Expand Down
4 changes: 2 additions & 2 deletions doc/developer-guide/api/functions/TSSslSecret.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Description

:func:`TSSslSecretSet` updates the current secret map. Generally the secret name corresponds to the name of a certificate or a key.
Future creation of SSL_CTX objects that use the secret will use the newly specified data. It can be useful to call this function
from the :data:`TS_LIFECYCLE_SSL_SECRET_HOOK`.
from the :cpp:enumerator:`TS_LIFECYCLE_SSL_SECRET_HOOK`.

TSSslSecretGet
**************
Expand Down Expand Up @@ -67,7 +67,7 @@ Synopsis

#include <ts/ts.h>

.. function:: TSReturnCode TSSslSecretGet(const char * secret_name, int secret_name_length)
.. function:: TSReturnCode TSSslSecretUpdate(const char * secret_name, int secret_name_length)
Comment thread
bneradt marked this conversation as resolved.

Description
===========
Expand Down
20 changes: 20 additions & 0 deletions doc/developer-guide/api/functions/TSTypes.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,26 @@ more widely. Those are described on this page.

Flag for using the remapped URL as an explicit redirection. This can be set by the remap plugin.

.. type:: TSSecretID

Contains the data for a TLS certificate and key.

.. member:: const char * cert_name;

The TLS certificate name.

.. member:: size_t cert_name_len;

The length of the TLS certificate name.

.. member:: const char * key_name;

The name of the TLS key.

.. member:: size_t key_name_len;

The length of the name of the TLS key.

.. type:: TSSslX509

This type represents the :code:`X509` object created from an SSL certificate.
Expand Down