Project-Rat-Extras Documentation
=====================================

.. image::
    ./_static/figs/docs/banner-1.svg
   :alt: Project-Rat-Extras Docs banner
   :align: left
   :class: img-bottom-padding
   :width: 100 %

Project-Rat-Extras_ (or PRE_) is a GitLab group offering
utilities for the Project-Rat_ GitLab group, a suite of open-source
C++ libraries for 3D magnetostatic simulations and magnet design.
See Rat-Docs_ for more information.

This repository serves as a global documentation portal for the
whole group in order to centralize information and knowledge in
the form of a Sphinx_ static website to be hosted on GitLab pages.

.. note::

   This project is under active development.

Overview
--------

Documentation covers repositories of this GitLab group:

- Docs_: general documentation
- Rat-vcpkg_: vcpkg ports and registry for Rat
- Rat-Containers_: container definitions and helpers for Rat
- pyRat_: Python bindings for Rat

The overall table of content is available here:

.. toctree::
   :maxdepth: 3
   :caption: CONTENTS

   introduction
   repo-docs/index
   repo-rat-vcpkg/index
   repo-rat-containers/index
   repo-pyrat/index

.. Links
.. _Docs: https://gitlab.com/project-rat-extras/docs
.. _Project-Rat: https://gitlab.com/project-rat
.. _Project-Rat-Extras: https://gitlab.com/project-rat-extras
.. _PRE: https://gitlab.com/project-rat-extras
.. _pyRat: https://gitlab.com/project-rat-extras/pyrat
.. _Rat-Containers: https://gitlab.com/project-rat-extras/rat-containers
.. _Rat-Docs: https://gitlab.com/project-rat/rat-documentation
.. _Rat-vcpkg: https://gitlab.com/project-rat-extras/rat-vcpkg
.. _Sphinx: https://www.sphinx-doc.org/en/master/index.html