Re: [PATCH 00/10] add support for sphinx-doc

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 02/23/2018 05:47 PM, Luc Van Oostenryck wrote:
> This series add support for sphinx. With this we can have
> nice HTML doc generated from either .rst or .md files.
> One of the goal is, of course, to have this doc; another one
> is to have a better input format for the manpage.
> 
> For the moment the generated doc can be accessed at:
> 	http://sparse-doc.rtfd.io

That's a good start.  Thanks.

> Luc Van Oostenryck (10):
>   doc: fix typo in options.md
>   doc: fix markdown syntax
>   doc: fix headings
>   doc: add minimal support for sphinx-doc
>   doc: add logo
>   doc: automatically set the copyright date
>   doc: allow .md with py3-sphinx
>   doc: move sparse.txt to markdown and rename it
>   doc: the man page in reST
>   doc: fix weirdness with option lists

+	@sed '/^\.BI \\-[a-zA-Z]\\fB /s/\\fB //' < build/man/$@ > $@

I would prefer to see a little explanation of that sed magic, if you don't mind.


>  Documentation/.gitignore           |   3 +
>  Documentation/Makefile             |  26 +++
>  Documentation/conf.py              | 169 +++++++++++++++
>  Documentation/index.rst            |  36 ++++
>  Documentation/logo.svg             |  94 ++++++++
>  Documentation/nocast-vs-bitwise.md |  41 ++++
>  Documentation/options.md           |  18 +-
>  Documentation/project-ideas.md     |   5 +-
>  Documentation/sparse.rst           | 427 +++++++++++++++++++++++++++++++++++++
>  Documentation/sparse.txt           |  45 ----
>  10 files changed, 807 insertions(+), 57 deletions(-)
>  create mode 100644 Documentation/.gitignore
>  create mode 100644 Documentation/Makefile
>  create mode 100644 Documentation/conf.py
>  create mode 100644 Documentation/index.rst
>  create mode 100644 Documentation/logo.svg
>  create mode 100644 Documentation/nocast-vs-bitwise.md
>  create mode 100644 Documentation/sparse.rst
>  delete mode 100644 Documentation/sparse.txt


-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-sparse" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Newbies FAQ]     [LKML]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Trinity Fuzzer Tool]

  Powered by Linux