

[release] linuxdoc v20240924

    $ git tag -a 20240924 -m 'Version '20240924'
    $ git push origin 20240924
    $ make upload-pypi




I merge this PR into master, @musicinmybrain, @sanjayankur31 is there anything else you miss? Otherwise I would build a new release on pypi.org.




docs/linuxdoc-howto/all-in-a-tumble.c:102: WARNING: Invalid C declaration: Expected end of definition. [error at 4]
  test-fnattrs
  ----^
docs/linuxdoc-howto/all-in-a-tumble.c:102: WARNING: Invalid C declaration: Expected end of definition. [error at 5]
  tests-internal
  -----^



[release] linuxdoc v20221025

    $ git tag -a 20221025 -m 20221025
    $ make upload-pypi



Issue exists since bug [426] has been fixed in [8836] and released in Docutils
[0.18].

[1]   https://docutils.sourceforge.io/docs/ref/rst/directives.html#column-widths
[426]  https://sourceforge.net/p/docutils/bugs/426/
[8836] https://sourceforge.net/p/docutils/code/8836/
       https://github.com/docutils/docutils/commit/846581
[0.18] http://www.docutils.org/RELEASE-NOTES.html#release-0-18-2021-10-26





[fix] sphinx 5.x: add `nav.contents` everywhere that `div.topic` is used

Previously, docutils produced `div.topic` for the contents directive, the latest
version produces `nav.contents`.  This means that those tables of contents
change appearance when switching to docutils 0.18 [1][2].

[1] https://github.com/sphinx-doc/sphinx/pull/10535/commits/5806f0a
[2] https://github.com/sphinx-doc/sphinx/issues/10534

BTW:

- highlight the current page in the sidebar
- sphinx-tabs should not overlap sidebar


Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>




Invalid value for classifiers. Error: Classifier 'Topic :: Documentation :: linux' is not a valid classifier.


+SPHINXOPTS    = -j12



# ------------------------------------------------------------------------------
# Options of the kernel-doc parser
# ------------------------------------------------------------------------------

# Set parser's default value for kernel-doc directive option  ``:exp-method:``
# default: kernel_doc_exp_method = 'macro'

# Set parser's default value for kernel-doc directive option ``:exp-ids:``.
# default: kernel_doc_exp_ids = \
#    ['EXPORT_SYMBOL', 'EXPORT_SYMBOL_GPL', 'EXPORT_SYMBOL_GPL_FUTURE']

# Set parser's default value for kernel-doc directive option  ``:known-attrs:``
# default: kernel_doc_known_attrs = [...]

# Global fallback for man section of kernel-doc directives.  Set this value if
# you want to create man pages for those kernel-doc directives, which has not
# been set a ``:man-sect:`` value.  The default is ``None``, which means; do the
# opposite and create only man pages for those directives which has been set the
# ``:man-sect:`` option.
# default: kernel_doc_mansect = None
kernel_doc_mansect = 9

# Set parser's default kernel-doc mode ``[reST|kernel-doc]``.  Normally you wont
# set anything other than the default!
# default: kernel_doc_mode = 'reST'

# If true, more warnings will be logged.  E.g. a missing description of a
# function's return value will be logged.
# default: kernel_doc_verbose_warn = True
kernel_doc_verbose_warn = False

# If ``True`` fatal errors (like missing function descriptions) raise an error.
# The default is ``True``. This means that the build process break every time a
# serve error in the documentation build occur.  Often it might be better the
# build continues and inserts Oops on serve errors.  For this, set
# ``kernel_doc_raise_error`` to ``False``.
# default kernel_doc_raise_error = True
kernel_doc_raise_error = False

# Oops messages are Sphinx ``.. todo::`` directives.  To insert the Oops
# messages from the kernel-doc parser we have to active todo_include_todos also.
todo_include_todos = True

# In nickpick mode, it will complain about lots of missing references that
#
# 1) are just typedefs like: bool, __u32, etc;
# 2) It will complain for things like: enum, NULL;
# 3) It will complain for symbols that should be on different
#    books (but currently aren't ported to ReST)
#
# The list below has a list of such symbols to be ignored in nitpick mode
#
nitpick_ignore = [
    ("c:type", "bool"),
    ("c:type", "enum"),
    ("c:type", "u16"),
    ("c:type", "u32"),
    ("c:type", "u64"),
    ("c:type", "u8"),
    ]

# ------------------------------------------------------------------------------
# Since loadConfig overwrites settings from the global namespace, it has to be
# the last statement in the conf.py file
# ------------------------------------------------------------------------------
loadConfig(globals())








