github/open62541
7
0
Fork 0
mirror of https://github.com/open62541/open62541.git synced 2025-06-03 04:00:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(doc) rewrite and overhaul sphinx configuration (#7106)

Browse Source 
* refactor(docs): add requirements.txt

* refactor(ci): install sphinx from requirements.txt

* refactor(docs): rewrite sphinx' conf.py

* refactor(ci): remove unused build_docs function

* feat(ci): configure dependabot to update sphinx and theme

* feat(docs): show version in project name

* fixup! refactor(docs): rewrite sphinx' conf.py

* feat(docs): try determining git branch to show as version

* fixup! feat(docs): try determining git branch to show as version

* fixup! fixup! feat(docs): try determining git branch to show as version
This commit is contained in:
marwinglaser 2025-02-18 22:59:17 +01:00 committed by GitHub
parent 0ad559eb25
commit 1c69d81e02
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 64 additions and 264 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/dependabot.yml vendored
View File

@ -9,3 +9,7 @@ updates:
directory: "/" # Location of package manifests directory: "/" # Location of package manifests
schedule: schedule:
interval: "weekly" interval: "weekly"
- package-ecosystem: pip
directory: /doc
schedule:
interval: "weekly"

4
.github/workflows/doc_upload.yml vendored
View File

@ -20,8 +20,8 @@ jobs:
- name: Install Dependencies - name: Install Dependencies
run: | run: |
sudo apt-get update sudo apt-get update
sudo apt-get install -y -qq python3-sphinx graphviz texlive-fonts-recommended texlive-latex-extra texlive-plain-generic texlive-latex-recommended latexmk texlive-fonts-extra sudo apt-get install -y -qq graphviz texlive-fonts-recommended texlive-latex-extra texlive-plain-generic texlive-latex-recommended latexmk texlive-fonts-extra
pip install sphinx-rtd-theme pip install -r doc/requirements.txt
- name: Build Documentation - name: Build Documentation
run: source tools/ci.sh && build_docs_pdf run: source tools/ci.sh && build_docs_pdf
- name: Checkout Website Repository - name: Checkout Website Repository

303
doc/conf.py
View File

@ -2,214 +2,70 @@
# License, v. 2.0. If a copy of the MPL was not distributed with this # License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/. # file, You can obtain one at http://mozilla.org/MPL/2.0/.
# -*- coding: utf-8 -*- # Configuration file for the Sphinx documentation builder.
# #
# open62541 documentation build configuration file, created by # For the full list of built-in configuration values, see the documentation:
# sphinx-quickstart on Sat May 23 19:39:37 2015. # https://www.sphinx-doc.org/en/master/usage/configuration.html
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys import subprocess
import os
import shlex
import sphinx_rtd_theme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------ def try_get_branch():
try:
git_res = subprocess.run(['git', 'branch', '--show-current'], capture_output=True, text=True)
if git_res.returncode != 0:
return None
return git_res.stdout.rstrip()
except OSError:
return None
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be # -- Project information -----------------------------------------------------
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
# ones.
extensions = ['sphinx.ext.graphviz'] version = try_get_branch() or '${OPEN62541_VER_MAJOR}.${OPEN62541_VER_MINOR}.${OPEN62541_VER_PATCH}' or "unknown"
release = '${OPEN62541_VER_MAJOR}.${OPEN62541_VER_MINOR}.${OPEN62541_VER_PATCH}${OPEN62541_VER_LABEL}'
project = 'open62541 (' + version + ')'
copyright = '2025, The open62541 authors'
author = 'The open62541 authors'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.graphviz',
'sphinx_rtd_theme',
]
templates_path = ['_templates']
exclude_patterns = []
language = 'en'
master_doc = 'toc'
numfig = True numfig = True
# Add any paths that contain templates here, relative to this directory. # -- Options for HTML output -------------------------------------------------
templates_path = ['_templates'] # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'toc'
# General information about the project.
project = u'open62541'
author = u'The open62541 authors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = "${OPEN62541_VER_MAJOR}.${OPEN62541_VER_MINOR}"
# The full version, including alpha/beta/rc tags.
release = "${OPEN62541_VER_MAJOR}.${OPEN62541_VER_MINOR}.${OPEN62541_VER_PATCH}${OPEN62541_VER_LABEL}"
# The full version, including alpha/beta/rc tags.
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
#exclude_patterns = ["client_config.rst", "server_config.rst"]
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme' html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
# Theme options are theme-specific and customize the look and feel of a theme html_logo = 'open62541_html.png'
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. pygments_style = 'sphinx' # TODO makes code blocks ugly (overrides sphinx_rtd_theme)
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "open62541_html.png"
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['.']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
#html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'doc/open62541doc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-latex-output
latex_logo = 'open62541.png'
latex_documents = [
# (startdocname, targetname, title, author, theme, toctree_only)
(master_doc, 'open62541.tex', 'open62541 Documentation', author, 'manual', False),
]
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
@ -267,67 +123,18 @@ latex_elements = {
#'figure_align': 'htbp', #'figure_align': 'htbp',
} }
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'open62541.tex', u'open62541 Documentation',
u'The open62541 authors', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = "open62541.png"
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------- # -- Options for manual page output ---------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-manual-page-output
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'open62541', u'open62541 Documentation', # (source start file, name, description, authors, manual section)
[author], 1) (master_doc, 'open62541', 'open62541 Documentation', [author], 1)
] ]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------- # -- Options for Texinfo output -------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-texinfo-output
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'open62541', u'open62541 Documentation', # (source start file, target name, title, author, dir menu entry, description, category)
author, 'open62541', 'One line description of project.', (master_doc, 'open62541', 'open62541 Documentation', author, 'open62541', 'One line description of project.', 'Miscellaneous'),
'Miscellaneous'),
] ]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

2
doc/requirements.txt Normal file
View File

@ -0,0 +1,2 @@
sphinx >= 5.3, < 9
sphinx-rtd-theme >= 1.2, < 4

13
tools/ci.sh
View File

@ -27,19 +27,6 @@ function cpplint {
make ${MAKEOPTS} cpplint make ${MAKEOPTS} cpplint
} }
#######################
# Build Documentation #
#######################
function build_docs {
mkdir -p build; cd build; rm -rf *
cmake -DCMAKE_BUILD_TYPE=Release \
-DUA_BUILD_EXAMPLES=ON \
-DUA_FORCE_WERROR=ON \
..
make doc
}
##################################### #####################################
# Build Documentation including PDF # # Build Documentation including PDF #
##################################### #####################################