Page 1 of 1
Doc WAPT
Published: April 21, 2017 - 10:39 AM
by OtOMatick
Hello,
your documentation is excellent!
https://www.wapt.fr/fr/doc/
Could you tell me what I need to implement the same kind of tool at my client's site?
I have a CentOS 7 server and would like to be able to present this type of documentation to my client.
It's clear, simple, and very well done!
Thank you for your feedback.
Re: WAPT Doc
Published: April 21, 2017 - 10:54 AM
by agauvrit
Hello,
First of all, thank you on behalf of Tranquil IT Systems. It's always a pleasure to receive compliments; the entire team is dedicated to providing documentation that is as comprehensive as possible.
Regarding the documentation itself, we generate it using reStructuredText, Docutils, and Sphinx.
If you've ever edited Markdown or a wiki, the heading organization is quite similar. The main difference is the documentation compilation process, which allows us to generate documentation in different languages and formats (HTML, PDF, ePub, and LaTeX).
If you'd like to learn more about RST, Sphinx, and Docutils:
https://www.jujens.eu/posts/2014/Aug/13 ... st-sphinx/
The official documentation is available here:
http://docutils.sourceforge.net/sandbox ... rt-fr.html
Alexandre
Re: WAPT Doc
Published: April 21, 2017 - 2:52 PM
by OtOMatick
Thanks, I got the result I wanted.
Now I'm going to look into how to do the same thing manually, because `
yum install` and
`pip install` don't suit my needs.
I prefer to maintain control over what I install, so I can install what I want, where I want (so starting from the tar.gz files).
(You wouldn't happen to have any documentation on how to install all this from source on CentOS, would you?)
((Even better! A ready-made, configurable package, including everything needed without dependencies.))
(((Hey, don't you do this for your clients? Distributing this kind of wiki via Wapt to client machines for their internal information. Few of them probably have intranets or wikis.)))
Re: WAPT Doc
Published: April 21, 2017 - 5:15 PM
by agauvrit
For a clean install, there isn't much documentation to be honest, apart from the Sphinx project's setup.py file:
https://github.com/sphinx-doc/sphinx/bl ... r/setup.py.
We don't use it on Windows; the documentation compilation bot from the Git repository (Jenkins) uses pip commands for dependency installation.
Good luck with RST anyway.
