Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
614 changes: 614 additions & 0 deletions docs/Examples/BlockSlide_1.ipynb

Large diffs are not rendered by default.

478 changes: 478 additions & 0 deletions docs/Examples/BlockSlide_2.ipynb

Large diffs are not rendered by default.

631 changes: 631 additions & 0 deletions docs/Examples/BlockSlide_3.ipynb

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions docs/Examples/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Examples
========

.. toctree::
:titlesonly:

BlockSlide_1.ipynb
BlockSlide_2.ipynb
BlockSlide_3.ipynb

26 changes: 13 additions & 13 deletions docs/api_reference.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. _api_reference:
=============
API Reference
=============
.. autosummary::
:toctree: _autosummary
:recursive:
pycollo.optimal_control_problem
pycollo.phase
.. _api_reference:

=============
API Reference
=============

.. autosummary::
:toctree: _autosummary
:recursive:

pycollo.optimal_control_problem
pycollo.phase

118 changes: 60 additions & 58 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,58 +1,60 @@
"""Configuration file for the Sphinx documentation builder.

For the full list of built-in configuration values, see the documentation:
https://www.sphinx-doc.org/en/master/usage/configuration.html
"""
import pathlib
import sys

# Add source folder to path for autodoc
path = pathlib.Path(__file__).parent.parent.absolute()
sys.path.insert(0, str(path))

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "Pycollo"
copyright = "2023, Sam Brockie" # noqa: A001
author = "Sam Brockie"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
]

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

napoleon_google_docstring = True
napoleon_custom_sections = [("Explanation", "notes_style")]

intersphinx_mapping = {
"cyipopt": ("https://cyipopt.readthedocs.io/en/stable/", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
"numba": ("https://numba.readthedocs.io/en/stable/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
"sympy": ("https://docs.sympy.org/latest/", None),
"python": ("http://docs.python.org/3", None),
}


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"

html_theme_options = {
"source_edit_link": "https://github.com/brocksam/pycollo/",
}

html_static_path = ["_static"]
"""Configuration file for the Sphinx documentation builder.

For the full list of built-in configuration values, see the documentation:
https://www.sphinx-doc.org/en/master/usage/configuration.html
"""
import pathlib
import sys

# Add source folder to path for autodoc
path = pathlib.Path(__file__).parent.parent.absolute()
sys.path.insert(0, str(path))

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "Pycollo"
copyright = "2023, Sam Brockie" # noqa: A001
author = "Sam Brockie"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"nbsphinx",

]

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

napoleon_google_docstring = True
napoleon_custom_sections = [("Explanation", "notes_style")]

intersphinx_mapping = {
"cyipopt": ("https://cyipopt.readthedocs.io/en/stable/", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
"numba": ("https://numba.readthedocs.io/en/stable/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
"sympy": ("https://docs.sympy.org/latest/", None),
"python": ("http://docs.python.org/3", None),
}


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"

html_theme_options = {
"source_edit_link": "https://github.com/brocksam/pycollo/",
}

html_static_path = ["_static"]
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Pycollo Documentation
=====================
Pycollo: an Open-Source Package for Multi Phase Direct Collocation.

.. toctree::
.. toctree::
:maxdepth: 2
:titlesonly:


Examples/index
api_reference
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
furo>=2023.5.20
sphinx>=6.1.3
nbsphinx>=0.9.2