Build doc pelican (lip6#11)

* Switch back to a generated version of the documentation.

Dependencies for the documentation generation have been added to poetry.
As Pelican is a Python tool, that makes sense.

Note to myself: To generate the doc with ccb.py we *need* to be inside
                the Python virtual env generated by Poetry. Instead of
		relying of a default one, provide one of our own
		(coriolis-venv) and make poetry run in it.

* Top builder.py now generated the doc.

* Forgot to remove generated PDFs in the documentation.

* A bit of cleanup on the README.rst

* Forgot the logo. Try to use code-block directive in README.

* Still typo in the logo path.

* One more trial at setting the image position.

* OK. That's enough for the logo.

* Problems with code-block.

* Voila!

* Build inside a venv and use poetry in the top level Makefile.

* Remove doxygen generated docs.

* More doc cleanup in oroshi.

Author: jpc-lip6

.gitignore

@@ -18,8 +18,14 @@ rtf/
 html/
 latex/
 
+build/
+coriolis-venv/
+coriolis.egg-info/
+
 bootstrap/coriolis2.spec
 
+documentation/output
+documentation/content/pdfs/*.pdf
 documentation/UsersGuide/UsersGuide-raw.tex
 documentation/UsersGuide/UsersGuide.tex
 documentation/UsersGuide/UsersGuide.aux

Makefile

@@ -14,6 +14,8 @@
    endif
  endif
 
+ venv = source ./venv/bin/activate
+
  SMP_FLAGS = 
  ifneq ($(shell which nproc 2> /dev/null),)
    SMP_FLAGS = -j$(shell nproc)
@@ -55,8 +57,17 @@ check_dir:
 	 fi
 
 
-install: check_dir
-	@./bootstrap/ccb.py $(DEVTOOLSET_OPTION) --project=support --project=coriolis --make="$(SMP_FLAGS) install"
+check_venv:
+	@if [ ! -d "./venv" ]; then python3 -m venv venv; fi
+
+
+poetry_deps: check_venv
+	@$(venv); poetry install --no-root 
+
+
+install: check_dir poetry_deps
+	@$(venv); ./bootstrap/ccb.py $(DEVTOOLSET_OPTION) --project=coriolis \
+	                                                  --make="$(SMP_FLAGS) --doc install"
 	@echo "";                                                                             \
 	 echo "============================================================================"; \
 	 echo "Coriolis has been successfully built";                                         \

README.rst

@@ -5,17 +5,39 @@
 .. |Python wheel builds| image:: https://github.com/lip6/coriolis/actions/workflows/wheels.yml/badge.svg
    :target: https://github.com/lip6/coriolis/actions/workflows/wheels.yml
 
+.. image:: documentation/content/images/common/Coriolis-logo-blue-4.png
+   :alt:   Coriolis Logo
+   :align: center
+   :width: 10%
 
-===============
-Coriolis README
-===============
 
-Coriolis is a free database, placement tool and routing tool for VLSI design.
+======================
+Coriolis Open EDA Tool
+======================
+
+Coriolis is a free database, placement and routing tool for VLSI design.
 
 This project is hosted at: https://github.com/lip6/coriolis
 
+Main documentation is available at: https://coriolis.lip6.fr/
+
 Development discussion can be found `on our Matrix Channel <https://matrix.to/#/#coriolis:matrix.org>`_ and in our `GitHub Discussions <https://github.com/lip6/coriolis/discussions>`_.
 
+Coriolis is part of a set of three repositories that are closely relateds.
+
+* Alliance
+
+  A venerable EDA toolchain, working only on symbolic layout. Some of it's
+  checking tools (LVS, DRC) are used for the regression tests in Alliance Check Toolkit.
+
+  https://github.com/lip6/alliance
+
+* Alliance Check Toolkit
+
+  A wide set of examples of designs and scripts to use by Coriolis.
+
+  https://github.com/lip6/alliance-check-toolkit
+
 
 Purpose
 =======
@@ -25,75 +47,68 @@ main components are the Hurricane database, the Etesian placer and the Katana
 router, but other tools can use the Hurricane database and the parsers
 provided.
 
-The user interface <cgt> is the prefered way to use Coriolis, but all
+The user interface ``cgt`` is the prefered way to run Coriolis, but all
 Coriolis tools are Python modules and thus scriptable.
 
 
-Documentation
-=============
-
-The complete documentation is available here, both in pdf & html:
-
-   ./documentation/output/html
-   ./documentation/UsersGuide/UsersGuide.pdf
-
-The documentation of the latest *stable* version is also
-available online. It may be quite outdated from the *devel*
-version.
-
-    https://www-soc.lip6.fr/sesi-docs/coriolis2-docs/coriolis2/en/latex/users-guide/UsersGuide.pdf
-
-
 Building Coriolis
 =================
 
 To build Coriolis, ensure the following prerequisites are met:
 
-* Python 3,
-* cmake,
-* boost,
-* bison & flex,
-* Qt 4 or 5,
-* libxml2,
-* RapidJSON,
 * A C++11 compliant compiler.
+* Python 3.
+* make or ninja.
+* cmake.
+* bzip2
+* boost.
+* bison & flex.
+* Qt 5 & Qt 5 Svg.
+* Qwt
+* libxml2.
+* RapidJSON, http://rapidjson.org/ .
+* Eigen 3,  http://eigen.tuxfamily.org .
+* Lemon, http://lemon.cs.elte.hu/trac/lemon .
+* doxygen
+* pelican
 
 The build system relies on a fixed directory tree from the root
 of the user currently building it. Thus first step is to get a clone of
-the repository in the right place. Proceed as follow: ::
+the repository in the right place. Proceed as follow:
+
+.. code-block:: bash
 
    ego@home:~$ mkdir -p ~/coriolis-2.x/src/
    ego@home:~$ cd ~/coriolis-2.x/src
-   ego@home:src$ git clone https://github.com/lip6/coriolis
+   ego@home:src$ git clone --recurse-submodules https://github.com/lip6/coriolis
    ego@home:src$ cd coriolis
 
-Then, build the tool: ::
+Then, build the tool:
+
+.. code-block:: bash
 
-    ego@home:coriolis$ make install
+   ego@home:coriolis$ make install
 
-If you encounter issues, please consult SUPPORT.rst for tips.
 Coriolis gets installed at the root of the following tree: ::
 
-    ~/coriolis-2.x/<OS>.<DISTRIB>/Release.Shared/install/
+    ~/coriolis-2.x/OS.DISTRIB/Release.Shared/install/
 
-Where ``<OS>`` is the name of your operating system and ``<DISTRIB>`` your
-distribution.
+Where ``OS`` is the name of your operating system and ``DISTRIB`` your
+distribution (mileage may vary).
 
 
 Using Coriolis
 ==============
 
-The Coriolis main interface can be launched with the command: ::
+Prior to using Coriolis, you need to setup your UNIX environment by running
+the following command:
 
-    ego@home:~: ~/coriolis-2.x/<OS>.<DISTRIB>/Release.Shared/install/bin/coriolis
+.. code-block:: bash
 
-The ``coriolis`` script detects its location and setups the UNIX
-environment appropriately, then lauches ``cgt`` (or *any* command, with the
-``--run=<COMMAND>`` option).
+    ego@home:~$ eval `~/coriolis-2.x/OS.DISTRIB/Release.Shared/install/etc/coriolis2/coriolisEnv.py`
 
-Conversely, you can setup the current shell environment for Coriolis by
-using the helper ``coriolisEnv.py``, then run any Coriolis tool: ::
+Then you can launch the GUI:
 
-    ego@home:~$ eval `~/coriolis-2.x/src/coriolis/bootstrap/coriolisEnv.py`
-    ego@home:~$ cgt -V
+.. code-block:: bash
 
+    ego@home:~$ cgt -V

builder.py

@@ -93,6 +93,7 @@ def build_cmake_extension(self, ext: CMakeExtension) -> None:
 
         cmake_args += ["-DPOETRY=1"]
         cmake_args += ["-DWITH_QT5=1"]
+        cmake_args += ["-DBUILD_DOC=TRUE"]
         cmake_args += ["-DCMAKE_BUILD_RPATH_USE_ORIGIN=1"]
         cmake_args += ["-DCMAKE_SKIP_BUILD_RPATH=FALSE"]
         cmake_args += ["-DCMAKE_BUILD_WITH_INSTALL_RPATH=FALSE"]