u-boot.git/doc/sphinx/kerneldoc.py, branch master

doc/sphinx: fix Python string escapes

2024-03-13T07:16:16+00:00

Python 3.6 introduced a DeprecationWarning for invalid escape sequences.
This is upgraded to a SyntaxWarning in Python 3.12, and will eventually
be a syntax error.

Fix these now to get ahead of it before it's an error.

Signed-off-by: Benjamin Gray 
Message-ID: <20230912060801.95533-3-bgray@linux.ibm.com>
Signed-off-by: Jonathan Corbet 

Adapted for U-Boot
Signed-off-by: Heinrich Schuchardt

docs/sphinx: Explicitly convert Sphinx paths to str

2024-01-17T07:40:19+00:00

Sphinx 7.2+ is switching to using pathlib.Path
instead of str to represent paths. This fixes the
current deprecation warnings and eventual breakage.
This conversion will be a no-op when using older
Sphinx versions.

Signed-off-by: Oliver Faso 
Tested-by: Akira Yokosawa 
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20230910040811.53046-1-erer1243@gmail.com
Signed-off-by: Heinrich Schuchardt

doc: require Sphinx 2.4.4

2021-08-14T18:54:41+00:00

Require Sphinx 2.44 to build the documentation.
Remove all code related to earlier versions.

Signed-off-by: Heinrich Schuchardt

doc: update Kernel documentation build system

2021-01-27T11:52:57+00:00

Update the documentation build system according to Linux v5.11-rc1.

Deactive the automarkup.py extension module which on Gitlab CI is
incompatible with Unicode.

With this patch we can build the HTML documentation using either of
Sphinx 2 and Sphinx 3.

Signed-off-by: Heinrich Schuchardt

Revert "doc: update Kernel documentation build system"

2021-01-23T17:51:37+00:00

Unfortunately we now see a number of now-fatal warnings about duplicate
labels.  It is often unclear how best to re-write the document in
question to not duplicate these otherwise logical headings.

This reverts commit 10a1df3cd43ba2fe893d5dd1aeb2e7109ef0007f.

Signed-off-by: Tom Rini

doc: update Kernel documentation build system

2021-01-23T14:53:17+00:00

Update the docomentation build system according to Linux v5.11-rc1.

With this patch we can build the HTML documentation using either of
Sphinx 2 and Sphinx 3.

Signed-off-by: Heinrich Schuchardt 
Reviewed-by: Simon Glass 
[Fix warning in b4860qds.rst about "Switch Settings"]
Signed-off-by: Tom Rini

doc: update doc/sphinx/kerneldoc.py

2020-02-24T16:07:51+00:00

Update doc/sphinx/kerneldoc.py from Linux next-20200219 to avoid warnings
like:

doc/sphinx/kerneldoc.py:125: RemovedInSphinx20Warning:
AutodocReporter is now deprecated. Use
sphinx.util.docutils.switch_source_input() instead.
  self.state.memo.reporter =
  	AutodocReporter(result, self.state.memo.reporter)

Signed-off-by: Heinrich Schuchardt

doc: Cope with Sphinx logging deprecations

2019-07-24T18:15:35+00:00

Recent versions of sphinx will emit messages like:

  doc/sphinx/kerneldoc.py:103:
     RemovedInSphinx20Warning: app.warning() is now deprecated.
     Use sphinx.util.logging instead.

Switch to sphinx.util.logging to make this unsightly message go away.
Alas, that interface was only added in version 1.6, so we have to add a
version check to keep things working with older sphinxes.

Signed-off-by: Jonathan Corbet 
Rebased for U-Boot
Signed-off-by: Heinrich Schuchardt

doc: Remove duplicated documentation directory

2019-06-20T14:57:08+00:00

Commit ad7061ed742e ("doc: Move device tree bindings documentation to
 doc/device-tree-bindings") moved all device tree binding documentation
to doc/device-tree-bindings directory.

The current U-Boot project still have two documentation directories:

- doc/
- Documentation/

Move all documentation and sphinx files to doc directory so all content
can be in a common place.

Signed-off-by: Breno Lima