[PATCH 8 of 9 saem V3] [doc] Use pkg-resources-include directive to include documentation from dependencies

Sylvain Thenault sylvain.thenault at logilab.fr
Wed Apr 12 08:57:08 CEST 2017


# HG changeset patch
# User Sylvain Thénault <sylvain.thenault at logilab.fr>
# Date 1491911976 -7200
#      Tue Apr 11 13:59:36 2017 +0200
# Node ID 45a7f7ae02be9c6f235df7b7673cb9b17cf613f0
# Parent  04d82e8990d0df261fdebaab341726fe6c006a6e
[doc] Use pkg-resources-include directive to include documentation from dependencies

diff --git a/dev-requirements.txt b/dev-requirements.txt
--- a/dev-requirements.txt
+++ b/dev-requirements.txt
@@ -1,4 +1,5 @@
 mock
 pytest
 webtest
 http://hg.logilab.org/review/cubes/seda/archive/tip.tar.bz2#egg=cubicweb-seda
+http://hg.logilab.org/review/cubes/eac/archive/tip.tar.bz2#egg=cubicweb-eac
diff --git a/doc-requirements.txt b/doc-requirements.txt
new file mode 100644
--- /dev/null
+++ b/doc-requirements.txt
@@ -0,0 +1,4 @@
+sphinx
+http://hg.logilab.org/review/cubes/seda/archive/tip.tar.bz2#egg=cubicweb-seda
+http://hg.logilab.org/review/cubes/eac/archive/tip.tar.bz2#egg=cubicweb-eac
+git+http://framagit.org/sthenault/saem-client@distribute-doc#egg=saemref-client
diff --git a/doc/client.rst b/doc/client.rst
--- a/doc/client.rst
+++ b/doc/client.rst
@@ -1,1 +1,1 @@
-.. include:: ../../saemref-client/README.rst
+.. pkg-resources-include:: saemref-client saemref_client/doc/README.rst
diff --git a/doc/eac.rst b/doc/eac.rst
--- a/doc/eac.rst
+++ b/doc/eac.rst
@@ -5,11 +5,11 @@ EAC-CPF
 Le référentiel fournit une implémentation de EAC-CPF_ relativement complète. Les notices d'autorités
 peuvent être créés ou importés directement dans l'interface web ou bien importés en ligne de
 commande.
 
 .. section sur les balises supportées ou non
-.. include:: ../../cubicweb-eac/doc/supported.rst
+.. pkg-resources-include:: cubicweb-eac cubicweb_eac/doc/supported.rst
 
 
 Import de notices d'autorités en ligne de commande
 ==================================================
 
diff --git a/doc/seda.rst b/doc/seda.rst
--- a/doc/seda.rst
+++ b/doc/seda.rst
@@ -1,1 +1,1 @@
-.. include:: ../../cubicweb-seda/doc/profils.rst
\ No newline at end of file
+.. pkg-resources-include:: cubicweb-seda cubicweb_seda/doc/profils.rst
\ No newline at end of file
diff --git a/tox.ini b/tox.ini
--- a/tox.ini
+++ b/tox.ini
@@ -33,11 +33,11 @@ commands = {envpython} -m pylint --disab
 [testenv:doc]
 changedir = doc
 whitelist_externals =
   sphinx-build
 deps =
-  sphinx
+  -rdoc-requirements.txt
 commands = sphinx-build -W -b html -d {envtmpdir}/doctrees .  {envtmpdir}/html
 
 [flake8]
 max-line-length = 100
 exclude = cubicweb_saem_ref/migration,cubicweb_saem_ref/uiprops.py,.tox,doc,cubicweb_saem_ref/scripts


More information about the saem-devel mailing list