Repository : http://git.fedorahosted.org/cgit/cura-tools.git
On branch : master
commit 6353405e63aeb711a3a68bb317349763c4f1e2a2 Author: Jan Safranek jsafrane@redhat.com Date: Wed Sep 17 12:30:00 2014 +0200
Add readthedocs target to makefiles.
For readthedocs.org, we do not want Contents, Tables and indices and similar chapters (i.e. we want the same as e.g. epub target), however we *do* want to include developer API documentation.
Therefore include shell/code and scripts/devel/api in the 'rtd' target.
doc/README.md | 6 +++++- doc/src/Makefile | 2 +- doc/src/scripts/Makefile | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/doc/README.md b/doc/README.md index 65a93d3..f17bd9b 100644 --- a/doc/README.md +++ b/doc/README.md @@ -5,7 +5,11 @@ It's available online on [pythonhosted][].
How to build ------------ -Supported builds are *html*, *pdflatex* and *epub*. +Supported builds are *html*, *pdflatex*, *epub* and *rtd*. + +*rtd* build is similar to *html*, i.e. generates html files, however these +files are intended to be included in overall OpenLMI documentation on +readthedocs.org. It ommits several chapters, which would clutter navigation.
### Requirements
diff --git a/doc/src/Makefile b/doc/src/Makefile index c73aa55..a4db2d0 100644 --- a/doc/src/Makefile +++ b/doc/src/Makefile @@ -86,7 +86,7 @@ shell-index-%: echo " shell/return_values"; \ echo " shell/interactive_interface"; \ echo " shell/builtins"; \ - if [ "$*" == html ]; then \ + if [ "$*" == html -o "$*" == rtd ]; then \ echo " shell/code"; \ fi; \ ) > shell-index.rst diff --git a/doc/src/scripts/Makefile b/doc/src/scripts/Makefile index 6f3afd4..716e35b 100644 --- a/doc/src/scripts/Makefile +++ b/doc/src/scripts/Makefile @@ -17,7 +17,7 @@ devindex: echo " devel/basics"; \ echo " devel/command-classes"; \ echo " devel/command-properties"; \ - if [ "$(BUILD)" == html ]; then \ + if [ "$(BUILD)" == html -o "$(BUILD)" == rtd ]; then \ echo " devel/api"; \ fi; \ ) > development.rst