Commit e376e2d2 authored by Jordan Musser's avatar Jordan Musser
Browse files

Particle distribution documentation (!72)

parent fdc840e2

.gitlab-ci.yml

+2 −2
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ workflow: 
docs:userguide:

  image: sphinxdoc/sphinx:latest

  script:

    - pip install -q sphinx_rtd_theme sphinx_tabs

    - pip install -q sphinx_rtd_theme sphinx_tabs sphinxcontrib-bibtex

    - sphinx-build -b html docs/source_docs/ build/docs

    - sphinx-build -b html docs/picvva/ build/picvva

  stage: build-docs
@@ -31,7 +31,7 @@ docs:codespell: 
  image: sphinxdoc/sphinx:latest

  script:

    - pip install codespell

    - codespell --enable-colors --quiet-level 2 docs/source_docs/ docs/picvva/

    - codespell --ignore-words-list strack --enable-colors --quiet-level 2 docs/source_docs/ docs/picvva/

  stage: build-docs

  tags:

    - docker

docs/source_docs/_static/theme_overrides.css

+7 −0
Original line number Diff line number Diff line
@@ -8,3 +8,10 @@ 
    max-width: 100%;

    overflow: visible;

}



.math {

    text-align: left;

}

.eqno {

    float: right;

}

docs/source_docs/conf.py

+5 −1
Original line number Diff line number Diff line
@@ -35,7 +35,8 @@ extensions = ['sphinx.ext.mathjax', 
              'sphinx.ext.githubpages',

              'sphinx.ext.viewcode',

              'sphinx_tabs.tabs',

              'sphinx.ext.todo']

              'sphinx.ext.todo',

              'sphinxcontrib.bibtex' ]



# Add any paths that contain templates here, relative to this directory.

templates_path = ['ytemplates']
@@ -84,6 +85,9 @@ todo_include_todos = False 
# This is necessary to reference numbered figures

numfig = True



math_numfig = True



bibtex_bibfiles = ['refs.bib']



# -- Options for HTML output ----------------------------------------------

docs/source_docs/definitions.rst

0 → 100644
+3 −0
Original line number Diff line number Diff line 


.. |cdot| unicode:: 0xB7 .. middle dot (https://www.compart.com/en/unicode/U+00B7)

docs/source_docs/index.rst

+3 −1
Original line number Diff line number Diff line
@@ -54,11 +54,14 @@ To learn more about the implementation, follow the following reference sections: 
   :caption: Reference:



   references/units

   references/size_distributions

   ManagingGridHierarchy_Chapter

   Fluids_Chapter

   Particles_Chapter

   EB_Chapter

   references/hpc

   Debugging

   works_cited



.. toctree::

   :maxdepth: 0
@@ -73,7 +76,6 @@ and performance: 
   :maxdepth: 0

   :caption: Tests and Benchmarks:



   ManagingGridHierarchy_Chapter

   RunningTestSuite

   RegressionTesting

   CITests