Commit graph

7 commits

Author SHA1 Message Date
Morris Jobke
a7e1003c41
Add shared_assets
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2018-01-29 01:19:51 +01:00
Morris Jobke
fe102f359c
Build current documentation
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2018-01-29 01:19:47 +01:00
Matthew Setter
8bd047174a Update client docs version string to 2.4.0
Need to update this to match the latest version.
2017-08-01 17:28:50 +02:00
Matthew Setter
9cc4d363b2 Fix the Sphinx-doc build configuration
I'm not sure what the configuration/setup has been like to date. But as
it stood, it didn't build successfully. Given that, I've created a copy
of doc/conf.py, included in this commit, from the default doc/conf.py.in
and set the appropriate variables as necessary.

NOTE: The build didn't work when the version, release, and latex_logo
values weren't set, either directly or with interpolatable values.
2017-02-21 11:49:23 +01:00
Daniel Molkentin
78c7dc95a0 Add doc cmake targets (HTML, PDF, QtHelp, CHM, man)
make doc will build all of the above, except for CHM,
which needs manual preparation and can be built with
make doc-chm. See doc/scripts/README.rst for details.

We do our best to ensure to detect the required tools
before adding targets, so a build should always succeed.

Exception: On Debian and Ubuntu, the following packages are
required to build the PDF target (in addition to pdflatex
itself, which is autodetected):

* texlive-latex-recommended
* texlive-latex-extra
* texlive-fonts-recommended

If pdflatex is present, but those are not, the doc target
will fail.

Results can be found in $BUILDDIR/doc/$format.
2012-11-25 00:38:47 +01:00
Daniel Molkentin
06e7864174 Doc: Require sphinx todo extension 2012-11-01 19:10:51 +01:00
Daniel Molkentin
bf8b9246fe Add docs 2012-10-27 17:05:01 +02:00