Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New docs using Sphinx + Breathe #568

Merged
merged 11 commits into from
May 20, 2021
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/build
3 changes: 3 additions & 0 deletions docs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ set(doxygen_output_dir "${CMAKE_CURRENT_BINARY_DIR}")
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/doxyfile.in"
"${CMAKE_CURRENT_BINARY_DIR}/doxyfile")

configure_file("${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in"
"${CMAKE_CURRENT_SOURCE_DIR}/conf.py")

add_custom_target(documentation
COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_CURRENT_BINARY_DIR}/html
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxyfile)
Binary file added docs/_images/400px/benzene-mo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/400px/bondcentric.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/400px/c180.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/400px/covid-spike.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/400px/ferrocene.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/400px/geoffclark3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/400px/gromacs-2.8M.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/400px/phenol-qtaim.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/400px/qtaim.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/400px/zeolite.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/OpenChemistry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/avogadro2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/benzene-mo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/bondcentric.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/c180.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/covid-spike.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ferrocene.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/geoffclark3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/gromacs-2.8M.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/phenol-qtaim.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/qtaim.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/zeolite.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/_templates/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<footer class="container-fluid footer-copy">

<div class="container">

<div class="row">
<div class="col-md-10 py-2">
<p>
{{ copyright }} The website content uses the <a href="https://github.com/openchemistry/avogadrolibs/blob/master/LICENSE">BSD License</a> and is covered by the <a href="https://github.com/openchemistry/avogadrolibs/blob/master/CODE_OF_CONDUCT.md">Avogadro Code of Conduct</a>.
</p>
</div>
<br />
<div class="col-md-2 py-2">
<a class="btn btn-primary" href="https://opencollective.com/open-chemistry">Donate</a>
</div>
</div>

</div>

</footer>
115 changes: 115 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
{%- extends "basic/layout.html" %}
{%- import "static/webpack-macros.html" as _webpack with context %}

{# prev/next buttons #}
{% macro prev_next(prev, next, prev_title='', next_title='') %}
{%- if prev %}
<a class='left-prev' id="prev-link" href="{{ prev.link|e }}" title="{{ _('previous page')}}">{{ prev_title or prev.title }}</a>
{%- endif %}
{%- if next %}
<a class='right-next' id="next-link" href="{{ next.link|e }}" title="{{ _('next page')}}">{{ next_title or next.title }}</a>
{%- endif %}
{% endmacro %}

{%- block css %}
{{ _webpack.head_pre_bootstrap() }}
{{ _webpack.head_pre_icons() }}
{% block fonts %}
{{ _webpack.head_pre_fonts() }}
{% endblock %}
{{- css() }}
{{ _webpack.head_js_preload() }}
{%- endblock %}

{%- block extrahead %}
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
{% for favicon in theme_favicons %}
{% if favicon.href[:4] == 'http'%}
<link rel="{{ favicon.rel }}" sizes="{{ favicon.sizes }}" href="{{ favicon.href }}">
{% else %}
<link rel="{{ favicon.rel }}" sizes="{{ favicon.sizes }}" href="{{ pathto('_static/' + favicon.href, 1) }}">
{% endif %}
{% endfor %}
{%- endblock %}

{# Silence the sidebar's, relbar's #}
{% block header %}{% endblock %}
{% block relbar1 %}{% endblock %}
{% block relbar2 %}{% endblock %}
{% block sidebarsourcelink %}{% endblock %}

{% block body_tag %}
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
{%- endblock %}
{%- block content %}
{# Added to support a banner with an alert #}
<div class="container-fluid" id="banner"></div>

{% block docs_navbar %}
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
{%- include "docs-navbar.html" %}
</nav>
{% endblock %}

<div class="container-xl">
<div class="row">
{% block docs_sidebar %}
{% if sidebars %}
<!-- Only show if we have sidebars configured, else just a small margin -->
<div class="col-12 col-md-3 bd-sidebar">
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
</div>
{% endif %}
{% endblock %}

{% block docs_toc %}
{% if sidebars %}
<div class="d-none d-xl-block col-xl-2 bd-toc">
{% if meta is defined and not (meta is not none and 'notoc' in meta) %}
{% for toc_item in theme_page_sidebar_items %}
<div class="toc-item">
{% include toc_item %}
</div>
{% endfor %}
{% endif %}
</div>
{% endif %}
{% endblock %}

{% block docs_main %}
{% if sidebars %}
{% set content_col_class = "col-md-9 col-xl-7" %}
{% else %}
{% set content_col_class = "col-md-12 ol-sm-12 col-lg-12 col-xl-12" %}
{% endif %}
<main class="col-12 {{ content_col_class }} py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
{% block docs_body %}
<div>
{% block body %} {% endblock %}
</div>
{% endblock %}
{% if theme_show_prev_next and pagename != 'index' %}
<div class='prev-next-bottom'>
{{ prev_next(prev, next) }}
</div>
{% endif %}
</main>
{% endblock %}

</div>
</div>


{%- block scripts_end %}
{{ _webpack.body_post() }}
{{ generate_google_analytics_script(id=theme_google_analytics_id) }}
{%- endblock %}

{%- endblock %}

{%- block footer %}
{%- include "footer.html" %}
{%- endblock %}
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_array.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Array
===========================

.. doxygenclass:: Avogadro::Core::Array
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_array_set.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::ArraySet
==============================

.. doxygenclass:: Avogadro::Core::ArraySet
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::ArraySet::Holder
======================================

.. doxygenclass:: Avogadro::Core::ArraySet::Holder
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::ArraySet::PlaceHolder
===========================================

.. doxygenclass:: Avogadro::Core::ArraySet::PlaceHolder
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_atom.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Atom
==========================

.. doxygenclass:: Avogadro::Core::Atom
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_atom_template.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::AtomTemplate
==================================

.. doxygenclass:: Avogadro::Core::AtomTemplate
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_atom_typer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::AtomTyper
===============================

.. doxygenclass:: Avogadro::Core::AtomTyper
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_avo_spglib.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::AvoSpglib
===============================

.. doxygenclass:: Avogadro::Core::AvoSpglib
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_basis_set.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::BasisSet
==============================

.. doxygenclass:: Avogadro::Core::BasisSet
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_bond.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Bond
==========================

.. doxygenclass:: Avogadro::Core::Bond
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_bond_template.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::BondTemplate
==================================

.. doxygenclass:: Avogadro::Core::BondTemplate
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_color3f.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Color3f
=============================

.. doxygenclass:: Avogadro::Core::Color3f
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::CoordinateBlockGenerator
==============================================

.. doxygenclass:: Avogadro::Core::CoordinateBlockGenerator
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_coordinate_set.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::CoordinateSet
===================================

.. doxygenclass:: Avogadro::Core::CoordinateSet
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_crystal_tools.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::CrystalTools
==================================

.. doxygenclass:: Avogadro::Core::CrystalTools
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_cube.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Cube
==========================

.. doxygenclass:: Avogadro::Core::Cube
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_elements.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Elements
==============================

.. doxygenclass:: Avogadro::Core::Elements
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_gaussian_set.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::GaussianSet
=================================

.. doxygenclass:: Avogadro::Core::GaussianSet
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::GaussianSetTools
======================================

.. doxygenclass:: Avogadro::Core::GaussianSetTools
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_graph.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Graph
===========================

.. doxygenclass:: Avogadro::Core::Graph
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_mesh.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Mesh
==========================

.. doxygenclass:: Avogadro::Core::Mesh
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_molecule.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Molecule
==============================

.. doxygenclass:: Avogadro::Core::Molecule
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::MoleculeDeserializer
==========================================

.. doxygenclass:: Avogadro::Core::MoleculeDeserializer
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::MoleculeSerializer
========================================

.. doxygenclass:: Avogadro::Core::MoleculeSerializer
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_mutex.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Mutex
===========================

.. doxygenclass:: Avogadro::Core::Mutex
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::NameAtomTyper
===================================

.. doxygenclass:: Avogadro::Core::NameAtomTyper
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_residue.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Residue
=============================

.. doxygenclass:: Avogadro::Core::Residue
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_residue_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::ResidueData
=================================

.. doxygenclass:: Avogadro::Core::ResidueData
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_ring_perceiver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::RingPerceiver
===================================

.. doxygenclass:: Avogadro::Core::RingPerceiver
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_shared_mutex.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::SharedMutex
=================================

.. doxygenclass:: Avogadro::Core::SharedMutex
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_slater_set.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::SlaterSet
===============================

.. doxygenclass:: Avogadro::Core::SlaterSet
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::SlaterSetTools
====================================

.. doxygenclass:: Avogadro::Core::SlaterSetTools
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_space_groups.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::SpaceGroups
=================================

.. doxygenclass:: Avogadro::Core::SpaceGroups
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::SymbolAtomTyper
=====================================

.. doxygenclass:: Avogadro::Core::SymbolAtomTyper
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_unit_cell.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::UnitCell
==============================

.. doxygenclass:: Avogadro::Core::UnitCell
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_variant.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::Variant
=============================

.. doxygenclass:: Avogadro::Core::Variant
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_core_1_1_variant_map.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::VariantMap
================================

.. doxygenclass:: Avogadro::Core::VariantMap
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Core::internal::ArrayRefContainer
=================================================

.. doxygenclass:: Avogadro::Core::internal::ArrayRefContainer
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_io_1_1_cjson_format.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Io::CjsonFormat
===============================

.. doxygenclass:: Avogadro::Io::CjsonFormat
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_io_1_1_cml_format.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Io::CmlFormat
=============================

.. doxygenclass:: Avogadro::Io::CmlFormat
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_io_1_1_dcd_format.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Io::DcdFormat
=============================

.. doxygenclass:: Avogadro::Io::DcdFormat
:members:
5 changes: 5 additions & 0 deletions docs/api/class/class_avogadro_1_1_io_1_1_file_format.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Class Avogadro::Io::FileFormat
==============================

.. doxygenclass:: Avogadro::Io::FileFormat
:members:
Loading