Re: [PATCH v2] doc: the man page in reST

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

 



On Mon, May 21, 2018 at 05:47:41PM +0100, Ramsay Jones wrote:
> On 21/05/18 03:50, Luc Van Oostenryck wrote:
> > 
> > Yes, most probably.
> > My point of view is that only sparse developers who make changes to
> > the documentation need to have sphinx installed (and thanks, sphinx
> > is sooo much simpler to install than most other doc toolchains).
> 
> Sorry for not looking for myself, but have you documented
> anywhere (for other sparse developers) how to install sphinx?
> 
> [and any other software necessary to re-build the docs, if any.]

No. not directly at least.
But in Documentation/doc-guide.rst there is a link to the sphinx
main page and from there you can find, among other things, instructions
for installing it.

That said:
* it's as easy as it could be:
  either (for Debian or Ubuntu)
	$ apt install python-sphinx
  or
	$ pip install sphinx
  and there is no other dependencies
* there is no absolute needs to generate the doc as the .rst and .md
  are quite legible as-is (but yes the HTML doc is nice, have an index, ...)
* the current version of the doc is available at
	http://sparse-doc.readthedocs.io/en/latest/
  (which correspond to the master branch of my stable tree)

But yes, I can certainly also add a link to
	http://www.sphinx-doc.org/en/stable/install.html

Best regards,
-- Luc
--
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