Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • BIND BIND
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 590
    • Issues 590
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 98
    • Merge requests 98
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • ISC Open Source ProjectsISC Open Source Projects
  • BINDBIND
  • Merge requests
  • !5205

Set version and release variables in conf.py

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Michał Kępień requested to merge 2782-set-version-and-release-variables-in-conf.py into main Jun 22, 2021
  • Overview 5
  • Commits 2
  • Pipelines 5
  • Changes 3

Some Sphinx variables used in the ARM are only set in Makefile.docs. This works fine when building the ARM using "make", but does not work with Read the Docs, which only looks at conf.py files.

Since Read the Docs does not run ./configure, renaming conf.py to conf.py.in and using Autoconf output variables is not a feasible solution.

Instead, extend doc/arm/conf.py with some Python code which processes configure.ac using regular expressions and sets the relevant Sphinx variables accordingly. As this solution also works fine when building the ARM using "make", drop the relevant -D options from the list of sphinx-build options used for building the ARM in Makefile.docs.

Note that the man_SPHINXOPTS counterparts of the removed -D switches are left intact because doc/man/conf.py is a separate Sphinx project which is only processed using "make" and duplicating the Python code added to doc/arm/conf.py by this commit would be inelegant.

Closes #2782 (closed)

Edited Dec 29, 2021 by Michał Kępień
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: 2782-set-version-and-release-variables-in-conf.py