Skip to content

Commit

Permalink
Documentation based on acf2e53
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jul 30, 2024
1 parent 37bb17e commit a5081c3
Show file tree
Hide file tree
Showing 22 changed files with 1,513 additions and 144 deletions.
53 changes: 53 additions & 0 deletions _sources/critdd.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
critdd package
==============

Subpackages
-----------

.. toctree::
:maxdepth: 4

critdd.tests

Submodules
----------

critdd.diagram module
---------------------

.. automodule:: critdd.diagram
:members:
:undoc-members:
:show-inheritance:

critdd.stats module
-------------------

.. automodule:: critdd.stats
:members:
:undoc-members:
:show-inheritance:

critdd.tikz module
------------------

.. automodule:: critdd.tikz
:members:
:undoc-members:
:show-inheritance:

critdd.tikz\_2d module
----------------------

.. automodule:: critdd.tikz_2d
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: critdd
:members:
:undoc-members:
:show-inheritance:
45 changes: 45 additions & 0 deletions _sources/critdd.tests.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
critdd.tests package
====================

Submodules
----------

critdd.tests.readme module
--------------------------

.. automodule:: critdd.tests.readme
:members:
:undoc-members:
:show-inheritance:

critdd.tests.stats module
-------------------------

.. automodule:: critdd.tests.stats
:members:
:undoc-members:
:show-inheritance:

critdd.tests.tikz module
------------------------

.. automodule:: critdd.tests.tikz
:members:
:undoc-members:
:show-inheritance:

critdd.tests.two\_d module
--------------------------

.. automodule:: critdd.tests.two_d
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: critdd.tests
:members:
:undoc-members:
:show-inheritance:
8 changes: 3 additions & 5 deletions _sources/developer-guide.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@ As soon as you push to the `main` branch, GitHub Actions will take out these uni
After locally building the documentation, open `docs/build/index.html` in your browser.

```bash
. venv/bin/activate
pip install -e .[docs]
cd docs/
sphinx-apidoc --force --output-dir source/ ../critdd
make html
venv/bin/pip install -e .[docs]
venv/bin/sphinx-apidoc --force --output-dir docs/source critdd
venv/bin/sphinx-build -M html docs/source docs/build
```

As soon as you push to the `main` branch, GitHub Actions will build the documentation, push it to the `gh-pages` branch, and publish the result on GitHub Pages: [https://mirkobunse.github.io/critdd](https://mirkobunse.github.io/critdd)
7 changes: 7 additions & 0 deletions _sources/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
critdd
======

.. toctree::
:maxdepth: 4

critdd
6 changes: 5 additions & 1 deletion _static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -237,6 +237,10 @@ a.headerlink {
visibility: hidden;
}

a:visited {
color: #551A8B;
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down
2 changes: 1 addition & 1 deletion _static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
3 changes: 1 addition & 2 deletions _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
const DOCUMENTATION_OPTIONS = {
VERSION: '0.0.1',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
Expand Down
4 changes: 2 additions & 2 deletions _static/language_data.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];


/* Non-minified version is copied as a separate JS file, is available */
/* Non-minified version is copied as a separate JS file, if available */

/**
* Porter Stemmer
Expand Down
Loading

0 comments on commit a5081c3

Please sign in to comment.