Skip to content

CDRIVER-6133 fix docs build with docutils 0.22.2 #2173

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+4 −20
Open

CDRIVER-6133 fix docs build with docutils 0.22.2 #2173

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18143a0
remove unused substitutions
kevinAlbs Nov 14, 2025
0466f8d
CDRIVER-6133 remove target references in substituions
kevinAlbs Nov 14, 2025
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
24 changes: 4 additions & 20 deletions src/libmongoc/doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,24 +128,6 @@ def _maybe_update_inventories(app: Sphinx):
html_use_index = True

rst_prolog = rf"""
.. |qenc:is-experimental| replace::

is part of the experimental
`Queryable Encryption <queryable-encryption_>`_ API and may be subject
to breaking changes in future releases.

.. |qenc:opt-is-experimental| replace::

This option |qenc:is-experimental|

.. |qenc:api-is-experimental| replace::

This API |qenc:is-experimental|

.. |qenc:range-is-experimental| replace::

Range algorithm is experimental only and not intended for public use. It is subject to breaking changes.

.. _the findAndModify command:
https://www.mongodb.com/docs/manual/reference/command/findAndModify/

Expand Down Expand Up @@ -188,10 +170,12 @@ def _maybe_update_inventories(app: Sphinx):
:cmake:command:`find_package() <command:find_package>`

.. |bson_t-storage-ptr| replace::
non-``NULL`` pointer to `overwritable storage <bson_lifetimes_>`_ for a :symbol:`bson_t`
non-``NULL`` pointer to `overwritable storage`_ for a :symbol:`bson_t`

.. |bson_t-opt-storage-ptr| replace::
maybe-``NULL`` pointer to `overwritable storage <bson_lifetimes_>`_ for a :symbol:`bson_t`
maybe-``NULL`` pointer to `overwritable storage`_ for a :symbol:`bson_t`

.. _overwritable storage: https://www.mongodb.com/docs/languages/c/c-driver/current/libbson/guides/lifetimes/#overwritable-storage

.. _mongodb_docs_cdriver: https://www.mongodb.com/docs/languages/c/c-driver/current/

Expand Down