Skip to content
Merged
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.DS_Store
docs/build
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)

if "%1" == "" goto help

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
4 changes: 4 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
pydata-sphinx-theme
sphinx
sphinx-design
sphinx-tabs
7 changes: 7 additions & 0 deletions docs/source/aerosol_phases/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
##############
Aerosol Phases
##############

.. toctree::
:maxdepth: 2
:caption: Contents:
7 changes: 7 additions & 0 deletions docs/source/aerosol_representations/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
######################
Aerosol Representation
######################

.. toctree::
:maxdepth: 2
:caption: Contents:
7 changes: 7 additions & 0 deletions docs/source/chemical_species/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
################
Chemical Species
################

.. toctree::
:maxdepth: 2
:caption: Contents:
30 changes: 30 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 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

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'CAMP Configuration'
copyright = '2023, OpenAtmos'
author = 'OpenAtmos'
release = '0.0.0'

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

extensions = [
'sphinx_design',
'sphinx_tabs.tabs',
]

templates_path = ['_templates']
exclude_patterns = []



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

html_theme = 'pydata_sphinx_theme'
html_static_path = ['_static']
57 changes: 57 additions & 0 deletions docs/source/examples/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
##########
Examples
##########

.. toctree::
:maxdepth: 2
:caption: Contents:


Chapman
=======

Top Level Config
----------------

.. tabs::

.. tab:: YAML

.. literalinclude:: ../../../examples/yaml/chapman/config.yaml
:language: yaml

.. tab:: JSON

.. literalinclude:: ../../../examples/json/chapman/config.json
:language: json


Reactions
---------

.. tabs::

.. tab:: YAML

.. literalinclude:: ../../../examples/yaml/chapman/reactions.yaml
:language: yaml

.. tab:: JSON

.. literalinclude:: ../../../examples/json/chapman/reactions.json
:language: json

Species
---------

.. tabs::

.. tab:: YAML

.. literalinclude:: ../../../examples/yaml/chapman/species.yaml
:language: yaml

.. tab:: JSON

.. literalinclude:: ../../../examples/json/chapman/species.json
:language: json
37 changes: 37 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. CAMP Configuration documentation master file, created by
sphinx-quickstart on Fri Jul 21 21:05:33 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

.. camp configuration documentation HTML titles
..
.. # (over and under) for module headings
.. = for sections
.. - for subsections
.. ^ for subsubsections
.. ~ for subsubsubsections
.. " for paragraphs

##############################################
Welcome to CAMP Configuration's documentation!
##############################################

.. toctree::
:maxdepth: 2
:caption: Contents:

aerosol_phases/index
aerosol_representations/index
chemical_species/index
examples/index
mechanisms/index
reactions/index



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
7 changes: 7 additions & 0 deletions docs/source/mechanisms/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
##########
Mechanisms
##########

.. toctree::
:maxdepth: 2
:caption: Contents:
25 changes: 25 additions & 0 deletions docs/source/reactions/arrhenius.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
=========
Arrhenius
=========

.. tabs::

.. tab:: YAML

.. code-block:: yaml

# Your YAML example here
key: value
array:
- item1
- item2

.. tab:: JSON

.. code-block:: json

// Your JSON example here
{
"key": "value",
"array": ["item1", "item2"]
}
9 changes: 9 additions & 0 deletions docs/source/reactions/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#########
Reactions
#########

.. toctree::
:maxdepth: 2
:caption: Contents:

arrhenius
Binary file added examples/.DS_Store
Binary file not shown.
Binary file added examples/json/chapman/chapman.zip
Binary file not shown.
6 changes: 6 additions & 0 deletions examples/json/chapman/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"camp-files": [
"species.json",
"reactions.json"
]
}
Loading