==================
About this website
==================

This is the repository for the TopoHelper_ application's documentation website.

The github-repository with the `source code for this web-site can be found here.`_

The `sourcecode for TopoHelper itself`_ can be found here.

.. _`source code for this web-site can be found here.`: https://github.com/bcattoor/topohelper-docs
.. _TopoHelper: https://bcattoor.github.io/topohelper/
.. _`sourcecode for TopoHelper itself`: https://github.com/bcattoor/topohelper/tree/master

==========================================================================================

Building it yourself
--------------------
Building the documentation: requirements on Windows:

- `PERL <http://strawberryperl.com>`_
- `MiKTex <https://miktex.org/download>`_
- `Python <https://www.python.org/downloads>`_
- `Sphinx <https://www.sphinx-doc.org/en/master/usage/installation.html#windows>`_
  -> ``C:\> pip install -U sphinx``

Install all of the above, and make sure you log off your user account. That way the environment variables (ea.: PATH) get reread from the registry.