doc and doc

learning rst... also
Patent2net · Jan 5, 2021 · 5064de5 · 5064de5
1 parent 2cf1124
commit 5064de5
Show file tree

Hide file tree

Showing 37 changed files with 163 additions and 210 deletions.
diff --git a/README.rst b/README.rst
@@ -2,7 +2,7 @@
 Welcome to Patent2Net
 ######################
 
-.. image:: dev/images/LogoP2N.png
+.. image:: core/images/LogoP2N.png
 	:target: /_build/index.html
 	:align: center
 	:width: 80%
@@ -13,7 +13,10 @@ Welcome to Patent2Net
 	:target: https://github.com/Patent2net/P2N-v3/tree/master 
 .. image:: https://img.shields.io/github/stars/Patent2net/P2N-v3?label=Github%20stars
 .. image:: https://img.shields.io/github/issues/Patent2net/P2N-v3
-
+.. image:: https://readthedocs.org/projects/p2n-v3/badge/?version=latest
+    :target: https://p2n-v3.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
 -----
 About
 -----

diff --git a/doc/_build/doctrees/documentation.doctree b/doc/_build/doctrees/documentation.doctree
diff --git a/doc/_build/doctrees/environment.pickle b/doc/_build/doctrees/environment.pickle
diff --git a/doc/_build/doctrees/index.doctree b/doc/_build/doctrees/index.doctree
diff --git a/doc/_build/doctrees/usage/index.doctree b/doc/_build/doctrees/usage/index.doctree
diff --git a/doc/_build/html/CHANGES.html b/doc/_build/html/CHANGES.html
@@ -37,8 +37,8 @@
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Contributing" href="historic/contributing.html" />
-    <link rel="prev" title="File extension and data formats for specific software" href="dev/exports.html" /> 
+    <link rel="next" title="Contribute to the project" href="historic/contributing.html" />
+    <link rel="prev" title="Development info" href="devindex.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -97,37 +97,37 @@
 <li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="dev/system.html">System configuration</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/dataModel.html">P2N Data model</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/exports.html">File extension and data formats for specific software</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/exports.html#chained-software">Chained software</a></li>
+<li class="toctree-l1"><a class="reference internal" href="core/index.html">Core informations</a></li>
 </ul>
 <ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Patent2Net CHANGES (in short)</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#dev1">2021-01-01 4.0.0-dev1</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#dev5">2020-11-30 3.1.0-dev5</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#dev4">2020-07-20 3.1.0-dev4</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#dev3">2020-07-20 3.1.0-dev3</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#dev2">2020-06-20 3.1.0-dev2</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id1">2020-01-20 3.1.0-dev1</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#dev0">2019 3.1.0-dev0</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#ending-development-3-1">2018 ending development 3.1</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#dev6-thanks-a-lot-andreas">2018-03-20 3.0.0-dev6 (Thanks a lot Andreas)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id2">2017-12-01 3.0.0-dev5</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id3">2017-12-01 3.0.0-dev4</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id4">2017-12-01 3.0.0-dev3</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id5">2017-12-01 3.0.0-dev2</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id6">2017-11-30 3.0.0-dev1</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id7">2016-11-01 2.0.0</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id8">2014-10-30 1.0.0</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id9">2014-03-04 0.9.0</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id10">2014-03-15 0.0.0</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="devindex.html">Development info</a><ul class="current">
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Patent2Net CHANGES (in short)</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#dev1">2021-01-01 4.0.0-dev1</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#dev5">2020-11-30 3.1.0-dev5</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#dev4">2020-07-20 3.1.0-dev4</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#dev3">2020-07-20 3.1.0-dev3</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#dev2">2020-06-20 3.1.0-dev2</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id1">2020-01-20 3.1.0-dev1</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#dev0">2019 3.1.0-dev0</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#ending-development-3-1">2018 ending development 3.1</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#dev6-thanks-a-lot-andreas">2018-03-20 3.0.0-dev6 (Thanks a lot Andreas)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id2">2017-12-01 3.0.0-dev5</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id3">2017-12-01 3.0.0-dev4</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id4">2017-12-01 3.0.0-dev3</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id5">2017-12-01 3.0.0-dev2</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id6">2017-11-30 3.0.0-dev1</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id7">2016-11-01 2.0.0</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id8">2014-10-30 1.0.0</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id9">2014-03-04 0.9.0</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id10">2014-03-15 0.0.0</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="historic/contributing.html">Contribute to the project</a></li>
+<li class="toctree-l2"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="release.html">Release</a></li>
+<li class="toctree-l2"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
-<li class="toctree-l1"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>
 </ul>
 
 
@@ -174,6 +174,8 @@
 
       <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
 
+          <li><a href="devindex.html">Development info</a> &raquo;</li>
+
       <li>Patent2Net CHANGES (in short)</li>
 
 
@@ -446,10 +448,10 @@ <h2>2014-03-15 0.0.0<a class="headerlink" href="#id10" title="Permalink to this
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="historic/contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="historic/contributing.html" class="btn btn-neutral float-right" title="Contribute to the project" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="dev/exports.html" class="btn btn-neutral float-left" title="File extension and data formats for specific software" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="devindex.html" class="btn btn-neutral float-left" title="Development info" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

diff --git a/doc/_build/html/_sources/documentation.rst.txt b/doc/_build/html/_sources/documentation.rst.txt
@@ -1,7 +1,9 @@
 ***************************
 Contribute to documentation
 ***************************
-
+.. image:: https://readthedocs.org/projects/p2n-v3/badge/?version=latest
+    :target: https://p2n-v3.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
 
 ============
 Introduction
@@ -11,8 +13,9 @@ Sphinx uses `reStructuredText <https://docutils.sourceforge.io/docs/user/rst/qui
 and straightforwardness of reStructuredText.
 
 The documentation can be built locally and also will be published to https://docs.ip-tools.org/patent2net/.
-It could also be pushed to https://readthedocs.org/.
+It is also pushed to https://readthedocs.org/.
 
+.. _note: it seems that latexmk fails due to svg graphics. (badges included from shield.io or readthedoc...
 
 =====
 Usage

diff --git a/doc/_build/html/_sources/index.rst.txt b/doc/_build/html/_sources/index.rst.txt
@@ -28,24 +28,15 @@
 
     historic/index
 
-
 .. toctree::
     :maxdepth: 1
 
-    dev/index
+    core/index
 
-###########
-Development
-###########	
-
 .. toctree::
     :maxdepth: 1
 
-    CHANGES
-    historic/contributing
-    documentation
-    release
-    todo
+    devindex
 
 
 ##################

diff --git a/doc/_build/html/_sources/usage/index.rst.txt b/doc/_build/html/_sources/usage/index.rst.txt
@@ -14,6 +14,7 @@ Please follow up with these resources to learn something about CQL:
 
 - `CQL query howto`_ by EPO
 - The `Contextual Query Language Specification`_
+- see also our web interface shortcut to build cql request :ref:`webinterface`
 
 .. _CQL query howto: follow the EPO's `pocket guide <http://documents.epo.org/projects/babylon/eponet.nsf/0/8C12F50E07515DBEC12581B00050BFDA/$File/espacenet-pocket-guide_en.pdf>`_.
 .. _Contextual Query Language Specification: https://www.loc.gov/standards/sru/cql/

diff --git a/doc/_build/html/configure.html b/doc/_build/html/configure.html
@@ -37,7 +37,7 @@
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="&lt;no title&gt;" href="dev/index.html" />
+    <link rel="next" title="Core informations" href="core/index.html" />
     <link rel="prev" title="When you know what you do..." href="historic/install.html" /> 
 </head>
 
@@ -108,17 +108,10 @@
 </li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="dev/system.html">System configuration</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/dataModel.html">P2N Data model</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/exports.html">File extension and data formats for specific software</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/exports.html#chained-software">Chained software</a></li>
+<li class="toctree-l1"><a class="reference internal" href="core/index.html">Core informations</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
-<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
-<li class="toctree-l1"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>
+<li class="toctree-l1"><a class="reference internal" href="devindex.html">Development info</a></li>
 </ul>
 
 
@@ -233,7 +226,7 @@ <h3>OPS registration<a class="headerlink" href="#ops-registration" title="Permal
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="dev/index.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="core/index.html" class="btn btn-neutral float-right" title="Core informations" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="historic/install.html" class="btn btn-neutral float-left" title="When you know what you do..." accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

diff --git a/doc/_build/html/documentation.html b/doc/_build/html/documentation.html
@@ -38,7 +38,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Release" href="release.html" />
-    <link rel="prev" title="Contributing" href="historic/contributing.html" /> 
+    <link rel="prev" title="Contribute to the project" href="historic/contributing.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -97,25 +97,25 @@
 <li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="dev/system.html">System configuration</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/dataModel.html">P2N Data model</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/exports.html">File extension and data formats for specific software</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/exports.html#chained-software">Chained software</a></li>
+<li class="toctree-l1"><a class="reference internal" href="core/index.html">Core informations</a></li>
 </ul>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
-<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Contribute to documentation</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#introduction">Introduction</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#on-linux">On Linux</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#on-windows">On Windows</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="devindex.html">Development info</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="historic/contributing.html">Contribute to the project</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Contribute to documentation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#introduction">Introduction</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#usage">Usage</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#on-linux">On Linux</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#on-windows">On Windows</a></li>
 </ul>
 </li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
-<li class="toctree-l1"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>
+<li class="toctree-l2"><a class="reference internal" href="release.html">Release</a></li>
+<li class="toctree-l2"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>
+</ul>
+</li>
 </ul>
 
 
@@ -162,6 +162,8 @@
 
       <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
 
+          <li><a href="devindex.html">Development info</a> &raquo;</li>
+
       <li>Contribute to documentation</li>
 
 
@@ -183,13 +185,14 @@
 
   <div class="section" id="contribute-to-documentation">
 <h1>Contribute to documentation<a class="headerlink" href="#contribute-to-documentation" title="Permalink to this headline">¶</a></h1>
+<a class="reference external image-reference" href="https://p2n-v3.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/p2n-v3/badge/?version=latest" /></a>
 <div class="section" id="introduction">
 <h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
 <p>Beautiful static HTML documentation can be easily built using the Sphinx documentation generator.
 Sphinx uses <a class="reference external" href="https://docutils.sourceforge.io/docs/user/rst/quickref.html">reStructuredText</a> as its markup language, and many of its strengths come from the power
 and straightforwardness of reStructuredText.</p>
 <p>The documentation can be built locally and also will be published to <a class="reference external" href="https://docs.ip-tools.org/patent2net/">https://docs.ip-tools.org/patent2net/</a>.
-It could also be pushed to <a class="reference external" href="https://readthedocs.org/">https://readthedocs.org/</a>.</p>
+It is also pushed to <a class="reference external" href="https://readthedocs.org/">https://readthedocs.org/</a>.</p>
 </div>
 <div class="section" id="usage">
 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
@@ -238,7 +241,7 @@ <h3>On Windows<a class="headerlink" href="#on-windows" title="Permalink to this
         <a href="release.html" class="btn btn-neutral float-right" title="Release" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="historic/contributing.html" class="btn btn-neutral float-left" title="Contributing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="historic/contributing.html" class="btn btn-neutral float-left" title="Contribute to the project" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

diff --git a/doc/_build/html/genindex.html b/doc/_build/html/genindex.html
@@ -95,14 +95,10 @@
 <li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="dev/index.html">Global architecture and data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="core/index.html">Core informations</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
-<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contribute to the project</a></li>
-<li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
-<li class="toctree-l1"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>
+<li class="toctree-l1"><a class="reference internal" href="devindex.html">Development info</a></li>
 </ul>