Skip to content

Better document Sphinx install instructions

Mauro Carvalho Chehab lkml 2 versions Applied

Status from this message: I've applied this set, thanks.

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest6 patches 4 repliesApplied
  2. v16 patches 2 repliesSuperseded

Patches in v2 Applied

#Subject and filesSizeRepliesApplied
1/6changes.rst: Update Sphinx minimal requirementsDocumentation/process/changes.rst+3 -30 replies
2/6docs-rst: move Sphinx install instructions to sphinx.rstDocumentation/doc-guide/sphinx.rst Documentation/process/changes.rst+19 -120 replies
3/6sphinx.rst: explain the usage of virtual environmentDocumentation/doc-guide/sphinx.rst+32 -00 replies
4/6sphinx.rst: fix unknown referenceDocumentation/doc-guide/sphinx.rst+1 -10 replies
5/6sphinx.rst: describe the install requirements for kfigureDocumentation/doc-guide/sphinx.rst+13 -00 replies
6/6sphinx.rst: better organize the documentation about PDF buildDocumentation/doc-guide/sphinx.rst+13 -80 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v2 yet.

Read the v2 thread

Cover letter [PATCH v2 0/6] Better document Sphinx install instructions

The Sphinx build chain is fragile: any upgrades can cause it to break.

That's what happened this week, when I upgraded my machines to Fedora 26.

So, add a separate chapter at sphinx.rst with Sphinx install instructions, moving it out of changes.rst. and better name patch 2/6.

v2: improved the text at changes.rst to point to the file name with the Sphinx build instructions.

Mauro Carvalho Chehab (6):
changes.rst: Update Sphinx minimal requirements
docs-rst: move Sphinx install instructions to sphinx.rst sphinx.rst: explain the usage of virtual environment sphinx.rst: fix unknown reference
sphinx.rst: describe the install requirements for kfigure sphinx.rst: better organize the documentation about PDF build

 Documentation/doc-guide/sphinx.rst | 69 +++++++++++++++++++++++++++++++++++++-
 Documentation/process/changes.rst  | 16 ++-------
 2 files changed, 71 insertions(+), 14 deletions(-)
Signature · 1 line
2.13.0