wireguard-linux/Documentation/doc-guide/sphinx.rst, branch jd/unified-crypt-queue

docs: Note that :c:func: should no longer be used

2019-06-26T17:20:21Z

Now that we can mark up function() automatically, there is no reason to use :c:func: and every reason to avoid it. Adjust the documentation to reflect that fact. Signed-off-by: Jonathan Corbet

sphinx.rst: Add note about code snippets embedded in the text

2019-06-14T20:43:02Z

There's a paragraph that explains how to create fixed width text block, but it doesn't explains how to create fixed width text inline, although this feature is really used through the documentation. Fix that adding a quick note about it. Signed-off-by: André Almeida Signed-off-by: Jonathan Corbet

docs: requirements.txt: recommend Sphinx 1.7.9

2019-05-30T16:42:05Z

As discussed at the linux-doc ML, while we'll still support version 1.3, it is time to recommend a more modern version. So, let's switch the minimal requirements to Sphinx 1.7.9, as it has the "-jauto" flag, with makes a lot faster when building documentation. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

docs-rst: doc-guide: Minor grammar fixes

2019-01-15T00:36:53Z

While using this guide to learn the new documentation method, I saw a few phrases that I felt could be improved. These small changes improve the grammar and choice of words to further enhance the installation instructions. Signed-off-by: Joel Nider Acked-by: Mike Rapoport Acked-by: Matthew Wilcox Signed-off-by: Jonathan Corbet

doc:process: add links where missing

2018-12-06T17:21:19Z

Some documents are refering to others without links. With this patch I add those missing links. This patch affects only documents under process/ and labels where necessary. Signed-off-by: Federico Vaga Signed-off-by: Jonathan Corbet

doc:doc-guide: fix a typo and an error

2018-06-26T15:07:25Z

Fix a typo in sphinx.rst and a minor error in parse-header.rst Signed-off-by: Federico Vaga Signed-off-by: Jonathan Corbet

sphinx.rst: Allow Sphinx version 1.6 at the docs

2017-08-26T21:50:27Z

Now that the PDF building issues with Sphinx 1.6 got fixed, update the documentation and scripts accordingly. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

sphinx.rst: document scripts/sphinx-pre-install script

2017-07-23T21:51:45Z

Now that we have a script to check for Sphinx dependencies, document it. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

sphinx.rst: better organize the documentation about PDF build

2017-07-17T19:18:42Z

Instead of having it on just one note, add a separate section. This way, we could later improve it, providing a better guide about the needed steps for PDF builds. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

sphinx.rst: describe the install requirements for kfigure

2017-07-17T19:18:36Z

As we now have a document describing the install requirements for Sphinx, add there the need for GraphViz and ImageMagick. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet