talos-op-linux/Documentation/doc-guide, branch master

Documentation: build warnings related to missing blank lines after explicit markups has been fixed

2020-02-05T17:30:03+00:00

Fix for several documentation build warnings related to missing blank lines after explicit mark up. Exact warning message: WARNING: Explicit markup ends without a blank line; unexpected unindent. Signed-off-by: Sameer Rahmani Link: https://lore.kernel.org/r/20200203201543.24834-1-lxsameer@gnu.org Signed-off-by: Jonathan Corbet

Add a maintainer entry profile for documentation

2020-01-24T16:48:39+00:00

Documentation should lead by example, so here's a basic maintainer entry profile for this subsystem. Reviewed-by: Matthew Wilcox (Oracle) Signed-off-by: Jonathan Corbet

Add a document on how to contribute to the documentation

2020-01-24T16:48:14+00:00

This is mostly a collection of thoughts for how people who want to help out can make the docs better. Hopefully the world will respond with a flurry of useful patches. Acked-by: Jani Nikula Reviewed-by: Matthew Wilcox (Oracle) Reviewed-by: Randy Dunlap Signed-off-by: Jonathan Corbet

kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'

2019-11-07T20:17:25+00:00

The 'functions' directive is not only for functions, but also works for structs/unions. So the name is misleading. This patch renames it to 'identifiers', which specific the functions/types to be included in documentation. We keep the old name as an alias of the new one before all documentation are updated. Signed-off-by: Changbin Du Signed-off-by: Jonathan Corbet

docs: remove extra conf.py files

2019-07-17T09:57:52+00:00

Now that the latex_documents are handled automatically, we can remove those extra conf.py files. Signed-off-by: Mauro Carvalho Chehab

Doc : doc-guide : Fix a typo

2019-06-28T15:04:14+00:00

fix the disjunction by replacing "of" with "or". Signed-off-by: Sheriff Esseson Signed-off-by: Jonathan Corbet

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

2019-06-26T17:20:21+00:00

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:02+00:00

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:05+00:00

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: doc-guide: remove the extension from .rst files

2019-04-19T18:46:27+00:00

On almost all places, we're including ReST files without the extension. Let's remove the extension here as well, in order to use just one standard. Suggested-by: Jani Nikula Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet