Repository :
http://git.fedorahosted.org/cgit/cura-tools.git
On branch : master
---------------------------------------------------------------
commit 206f67787c8c8e8fff865f3bdc324c9efeff7fb0
Author: Michal Minar <miminar(a)redhat.com>
Date: Thu Oct 2 14:44:45 2014 +0200
doc: rename the top-level heading for rtd build
*OpenLMI Tools* doesn't look good together with *OpenLMI server
components*. Let's give it similar and obvious name *OpenLMI client
components*.
This applies only to all-inclusive documentation hosted on
readthedocs.org.
---------------------------------------------------------------
doc/README.md | 3 +++
doc/src/Makefile | 2 +-
doc/src/index-html.txt | 1 +
doc/src/index-other.txt | 1 +
doc/src/index-rtd.txt | 13 +++++++++++++
5 files changed, 19 insertions(+), 1 deletions(-)
diff --git a/doc/README.md b/doc/README.md
index 3e98b88..72d612c 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -39,6 +39,9 @@ This build is the preferred one for Python Hosted site.
This build includes documentation of [OpenLMI Scripts][].
ln -sf path/to/local/copy/of/openlmi-scripts openlmi-scripts
+ pushd openlmi-scripts
+ make setup # make sure that setup scripts exist
+ popd
WITH_COMMANDS=1 make html
How to upload
diff --git a/doc/src/Makefile b/doc/src/Makefile
index 69d6135..af9a8ee 100644
--- a/doc/src/Makefile
+++ b/doc/src/Makefile
@@ -52,7 +52,7 @@ index-%: subindexes-%
echo " api"; \
fi; \
) > toc.txt
- if [ "$*" == html ]; then \
+ if [[ "$*" =~ ^(html|rtd)$$ ]]; then \
ln -sf index-$*.txt index.rst; \
else \
ln -sf index-other.txt index.rst; \
diff --git a/doc/src/index-html.txt b/doc/src/index-html.txt
index 3b23e6f..dbb22d8 100644
--- a/doc/src/index-html.txt
+++ b/doc/src/index-html.txt
@@ -1,4 +1,5 @@
.. _openlmi-tools:
+.. _openlmi-client-components:
OpenLMI Tools documentation
===========================
diff --git a/doc/src/index-other.txt b/doc/src/index-other.txt
index 657ba45..7f73a68 100644
--- a/doc/src/index-other.txt
+++ b/doc/src/index-other.txt
@@ -1,4 +1,5 @@
.. _openlmi-tools:
+.. _openlmi-client-components:
OpenLMI Tools documentation
===========================
diff --git a/doc/src/index-rtd.txt b/doc/src/index-rtd.txt
new file mode 100644
index 0000000..cfd2bfa
--- /dev/null
+++ b/doc/src/index-rtd.txt
@@ -0,0 +1,13 @@
+.. _openlmi-tools:
+.. _openlmi-client-components:
+
+OpenLMI client components
+=========================
+They consist of several client-side python utilities and libraries. We refer
+to them as `OpenLMI Tools` and ship them under obvious name `openlmi-tools`.
+
+Currently they contain :ref:`lmi_shell` and :ref:`lmi_metacommand`.
+
+.. include:: toc.txt
+
+.. _OpenLMI Project:
http://www.openlmi.org/