[PATCH 6 of 7 sherpa] [doc] Use include-url directive

Sylvain Thénault sylvain.thenault at logilab.fr
Wed Apr 12 16:44:45 CEST 2017



Le 12/04/2017 à 16:37, Philippe Pepiot a écrit :
> On 04/12/2017 11:46 AM, Sylvain Thenault wrote:
>> # HG changeset patch
>> # User Sylvain Thénault <sylvain.thenault at logilab.fr>
>> # Date 1491989324 -7200
>> #      Wed Apr 12 11:28:44 2017 +0200
>> # Node ID fb79308e98a699d2b02faf12c87e6d6abee352ff
>> # Parent  f42a05fef21ff1c0b4196a05d802e0f0add4ddef
>> [doc] Use include-url directive
>>
>> diff --git a/doc/conf.py b/doc/conf.py
>> --- a/doc/conf.py
>> +++ b/doc/conf.py
>> @@ -16,11 +16,13 @@ import sys
>>  import os
>>
>>  # If extensions (or modules to document with autodoc) are in another
>> directory,
>>  # add these directories to sys.path here. If the directory is
>> relative to the
>>  # documentation root, use os.path.abspath to make it absolute, like
>> shown here.
>> -#sys.path.insert(0, os.path.abspath('.'))
>> +sys.path.insert(0, os.path.abspath('.'))
>> +
>> +import rext  # noqa
>>
>>  # -- General configuration
>> ------------------------------------------------
>>
>>  # If your documentation needs a minimal Sphinx version, state it here.
>>  #needs_sphinx = '1.0'
>> diff --git a/doc/eac.rst b/doc/eac.rst
>> --- a/doc/eac.rst
>> +++ b/doc/eac.rst
>> @@ -6,11 +6,11 @@ Le référentiel fournit une implémenta
>>  peuvent être créés ou importés directement dans l'interface web ou
>> bien importés en ligne de
>>  commande. Pour le moment, l'interface utilisateur permet néanmoins
>> d'éditer qu'un petit
>>  sous-ensemble du modèles.
>>
>>  .. section sur les balises supportées ou non
>> -.. include:: ../../cubicweb-eac/doc/supported.rst
>> +.. include-url::
>> https://hg.logilab.org/review/cubes/eac/raw-file/tip/doc/supported.rst
>>
>>
>>  Import de notices d'autorités en ligne de commande
>>  ==================================================
>>
>> diff --git a/doc/profils.rst b/doc/profils.rst
>> --- a/doc/profils.rst
>> +++ b/doc/profils.rst
>> @@ -1,1 +1,1 @@
>> -.. include:: ../../cubicweb-seda/doc/profils.rst
>> \ No newline at end of file
>> +.. include-url::
>> https://hg.logilab.org/review/cubes/seda/raw-file/tip/doc/profils.rst
>> diff --git a/doc/seda.rst b/doc/seda.rst
>> --- a/doc/seda.rst
>> +++ b/doc/seda.rst
>> @@ -1,2 +1,1 @@
>> -
>> -.. include:: ../../cubicweb-seda/doc/seda2_compat.rst
>> \ No newline at end of file
>> +.. include-url::
>> https://hg.logilab.org/review/cubes/seda/raw-file/tip/doc/seda2_compat.rst
>>
>
>
> So we don't need pkg-resource-include from patch 2 and patches in seda
> and eac that add doc/ to python package ?

right, though I've kept the pkg-resource directive for now as an example
that work, but we may suppose we won't ever use it and drop it.

-- 
Sylvain Thénault, LOGILAB, Paris (01.45.32.03.12) - Toulouse (05.62.17.16.42)
Formations Python, Debian, Méth. Agiles: http://www.logilab.fr/formations
Développement logiciel sur mesure:       http://www.logilab.fr/services
CubicWeb, the semantic web framework:    http://www.cubicweb.org



More information about the saem-devel mailing list