Skip to content

Commit

Permalink
doc doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Patent2net
Patent2net committed Jan 11, 2021
1 parent 0d45620 commit b0184ed
Show file tree
Hide file tree
Showing 25 changed files with 546 additions and 210 deletions.
1 change: 1 addition & 0 deletions .idea/.name
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 4 additions & 20 deletions .idea/workspace.xml
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ Project information: Who we are
The source code of the Patent2Net toolkit is available under an open source license,
see also `Patent2Net on GitHub <https://github.com/Patent2net/P2N-v3/tree/master>`_

The project is elaborated and maintained by an `international team <http://patent2netv2.vlab4u.info/dokuwiki/doku.php?id=about_p2n:community>`_
of university professors and researchers on a free basis.
The project is elaborated and maintained by an international team of university professors and researchers on a free basis.

-------
License
Expand All @@ -82,7 +81,7 @@ Documentation
Doc and wiki
^^^^^^^^^^^^

* `Wiki <http://patent2netv2.vlab4u.info/dokuwiki/>`_
* `Wiki <https://github.com/Patent2net/P2N-v3/wiki>`_
* `Documentation <https://docs.ip-tools.org/patent2net/>`_


Expand Down
Binary file modified doc/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified doc/_build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified doc/_build/doctrees/setup.doctree
View file
Binary file not shown.
82 changes: 59 additions & 23 deletions doc/_build/html/CHANGES.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@


<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="search" title="Search" href="search.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">
Expand Down Expand Up @@ -85,31 +87,54 @@



<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">Patent2Net CHANGES (in short)</a><ul>
<li><a class="reference internal" href="#dev1">2021-01-01 4.0.0-dev1</a></li>
<li><a class="reference internal" href="#dev5">2020-11-30 3.1.0-dev5</a></li>
<li><a class="reference internal" href="#dev4">2020-07-20 3.1.0-dev4</a></li>
<li><a class="reference internal" href="#dev3">2020-07-20 3.1.0-dev3</a></li>
<li><a class="reference internal" href="#dev2">2020-06-20 3.1.0-dev2</a></li>
<li><a class="reference internal" href="#id1">2020-01-20 3.1.0-dev1</a></li>
<li><a class="reference internal" href="#dev0">2019 3.1.0-dev0</a></li>
<li><a class="reference internal" href="#ending-development-3-1">2018 ending development 3.1</a></li>
<li><a class="reference internal" href="#dev6-thanks-a-lot-andreas">2018-03-20 3.0.0-dev6 (Thanks a lot Andreas)</a></li>
<li><a class="reference internal" href="#id2">2017-12-01 3.0.0-dev5</a></li>
<li><a class="reference internal" href="#id3">2017-12-01 3.0.0-dev4</a></li>
<li><a class="reference internal" href="#id4">2017-12-01 3.0.0-dev3</a></li>
<li><a class="reference internal" href="#id5">2017-12-01 3.0.0-dev2</a></li>
<li><a class="reference internal" href="#id6">2017-11-30 3.0.0-dev1</a></li>
<li><a class="reference internal" href="#id7">2016-11-01 2.0.0</a></li>
<li><a class="reference internal" href="#id8">2014-10-30 1.0.0</a></li>
<li><a class="reference internal" href="#id9">2014-03-04 0.9.0</a></li>
<li><a class="reference internal" href="#id10">2014-03-15 0.0.0</a></li>
<p class="caption"><span class="caption-text">Setup</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="setup.html">Quick start</a></li>
</ul>
<p class="caption"><span class="caption-text">Usage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
</ul>
<p class="caption"><span class="caption-text">Avanced setup</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
</ul>
<p class="caption"><span class="caption-text">Core information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="core/index.html">Global architecture and data model</a></li>
</ul>
<p class="caption"><span class="caption-text">Development information</span></p>
<ul class="current">
<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>
</div>
</li>
</ul>



</div>
Expand Down Expand Up @@ -154,6 +179,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>


Expand Down Expand Up @@ -424,6 +451,15 @@ <h2>2014-03-15 0.0.0<a class="headerlink" href="#id10" title="Permalink to this
</div>
<footer>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<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="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>


<hr/>

Expand Down
22 changes: 12 additions & 10 deletions doc/_build/html/_sources/setup.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,36 +1,38 @@
.. _setup:

###############
Getting started
###############

************
###########
Quick start
************
###########

This part of the documentation covers the installation of Patent2Net.
The first step to using any software package is getting it properly installed.
Please read this section carefully.

============
************
Installation
============
************
#. Install docker desktop
#. download the docker-install repository (https://github.com/Patent2net/P2N-Docker)
#. Use the Install_P2N.bat and enjoy Patent2Net via docker image
#. See Install.bat in the elatickibana directory for the full architecture (BETA) with elastic search and Kibana
#. Refer to :ref:`docker-install` procedures for details

=============
**************
Configuration
=============
**************
- setup your EPO's API key in the `get_started page: <http://localhost:5000/get_started)>`_
- enjoy the request form (http://localhost:5000/form) to make your requests and see progress (Help need to fix UX and SSE consolidate)
- explore results: http://localhost:5000/index
- please help in user design interface!
- go to the :ref:`docker-config` section for details on the interface
- see :ref:`usage` for details.

.. hint: the following on this page concerns developpers and avanced users information. Welcome to new users that should follow first theses pages :ref:`docker-install`, :ref:`usage`.
***************************
The old way for developpers
***************************

.. tip:: the following on this page concerns developpers and avanced users information. Welcome to new users that should follow first theses pages :ref:`docker-install`, :ref:`usage`.


.. include:: ./historic/install.rst
50 changes: 41 additions & 9 deletions doc/_build/html/configure.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@


<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Global architecture and data model" href="core/index.html" />
<link rel="prev" title="When you know what you do..." href="historic/install.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -85,19 +87,38 @@



<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">Configuration</a><ul>
<li><a class="reference internal" href="#docker-version-via-web-interface">Docker version via web interface</a></li>
<li><a class="reference internal" href="#manual-way">Manual way</a><ul>
<li><a class="reference internal" href="#ops-credentials">OPS credentials</a></li>
<li><a class="reference internal" href="#ops-registration">OPS registration</a></li>
<p class="caption"><span class="caption-text">Setup</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="setup.html">Quick start</a></li>
</ul>
<p class="caption"><span class="caption-text">Usage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
</ul>
<p class="caption"><span class="caption-text">Avanced setup</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="historic/index.html">Historical features</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="historic/index.html#developper-s-mode">Developper's mode</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="historic/index.html#installation">installation</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="historic/index.html#configure">configure</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#">Configuration</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="historic/index.html#operation">Operation</a></li>
</ul>
</li>
</ul>
</div>
</li>
</ul>
<p class="caption"><span class="caption-text">Core information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="core/index.html">Global architecture and data model</a></li>
</ul>
<p class="caption"><span class="caption-text">Development information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="devindex.html">Development info</a></li>
</ul>



</div>
Expand Down Expand Up @@ -142,6 +163,8 @@

<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>

<li><a href="historic/index.html">Historical features</a> &raquo;</li>

<li>Configuration</li>


Expand Down Expand Up @@ -206,6 +229,15 @@ <h3>OPS registration<a class="headerlink" href="#ops-registration" title="Permal
</div>
<footer>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="core/index.html" class="btn btn-neutral float-right" title="Global architecture and data model" 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>

</div>


<hr/>

Expand Down

0 comments on commit b0184ed

Please sign in to comment.