-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #104 from yardasol/vc-docs
Versioned documenation hosting
- Loading branch information
Showing
11 changed files
with
200 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
{%- if current_version %} | ||
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> | ||
<span class="rst-current-version" data-toggle="rst-current-version"> | ||
<span class="fa fa-book"> Other Versions</span> | ||
v: {{ current_version.name }} | ||
<span class="fa fa-caret-down"></span> | ||
</span> | ||
<div class="rst-other-versions"> | ||
{%- if versions.tags %} | ||
<dl> | ||
<dt>Tags</dt> | ||
{%- for item in versions.tags %} | ||
<dd><a href="{{ item.url }}">{{ item.name }}</a></dd> | ||
{%- endfor %} | ||
</dl> | ||
{%- endif %} | ||
{%- if versions.branches %} | ||
<dl> | ||
<dt>Branches</dt> | ||
{%- for item in versions.branches %} | ||
<dd><a href="{{ item.url }}">{{ item.name }}</a></dd> | ||
{%- endfor %} | ||
</dl> | ||
{%- endif %} | ||
</div> | ||
</div> | ||
{%- endif %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
name: saltproc-doc-env | ||
channels: | ||
- conda-forge | ||
- defaults | ||
dependencies: | ||
- pyne>=0.5.11 | ||
- numpy>=1.14.0 | ||
- pytables | ||
- networkx | ||
- pydotplus | ||
- sphinx | ||
- sphinx_rtd_theme | ||
- pip: | ||
- sphinx-multiversion | ||
- sphinxcontrib-apidoc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,28 +18,48 @@ SaltProc has the following dependencies: | |
.. _PyTables: http://pytables.org | ||
.. _NetworkX: http://networkx.github.io | ||
.. _PyDotPlus: https://pydotplus.readthedocs.io/ | ||
.. _pytest: https://docs.pytest.org | ||
.. _sphinx: https://www.sphinx-doc.org | ||
.. _sphinx-rtd-theme: https://sphinx-rtd-theme.readthedocs.io | ||
.. _matplotlib: http://matplotlib.org | ||
.. _ViTables: http://vitables.org | ||
.. _GitHub: http://github.com/arfc/saltproc | ||
|
||
.. _conda package manager: https://docs.conda.io/en/latest/ | ||
.. _mamba: https://github.com/mamba-org/mamba | ||
|
||
Optional Depenendencies: | ||
|
||
#. `pytest`_ (for testing) | ||
#. `sphinx`_ and `sphinx-rtd-theme`_ (for building documentation) | ||
#. `matplotlib`_ | ||
#. `ViTables`_ | ||
|
||
|
||
|
||
Most of the dependencies are readily available through package managers. | ||
Once all the dependencies are installed, SaltProc can be installed. | ||
Clone the source from the SaltProc repository from `GitHub`_. | ||
Then run the following commands from the directory above cloned repository: | ||
|
||
.. code-block:: bash | ||
git clone https://github.com/arfc/saltproc.git | ||
git clone [email protected]:arfc/saltproc.git | ||
All of the dependencies are readily available through the `conda package manager`_. | ||
|
||
.. note:: We recommend using the `mamba`_ CLI tool to install packages quickly. SaltProc has a compltex package dependency structure which can result is long environment solve times in the default ``conda`` solver. ``mamba`` is a reimplementation of ``conda`` in ``C++`` and we have found it is significantly faster. | ||
|
||
You can download the required ones using ``conda`` on the provided ``environment.yml`` | ||
file in the repository: | ||
|
||
.. code-block:: bash | ||
cd saltproc/ | ||
python setup.py install --user | ||
conda env create -f environment.yml | ||
Once all the dependencies are installed, SaltProc can be installed by | ||
running the following commands from within the cloned directory | ||
repository (assuming the `saltproc-env` environment is active): | ||
|
||
.. code-block:: bash | ||
pip install . | ||
Please let us know if you run into trouble. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
<!DOCTYPE html> | ||
<html> | ||
<head> | ||
<title>Redirecting to master branch</title> | ||
<meta charset="utf-8"> | ||
<meta http-equiv="refresh" content="0; url=./master/index.html"> | ||
<link rel="canonical" href="https://arfc.github.io/saltproc/master/index.html"> | ||
</head> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,13 @@ | ||
name: saltproc-env | ||
channels: | ||
- conda-forge | ||
- defaults | ||
dependencies: | ||
- pyne>=0.5.11 | ||
- numpy>=1.14.0 | ||
- pytables | ||
- networkx | ||
- pydotplus | ||
- pytest | ||
- sphinx | ||
- sphinx_rtd_theme | ||
- pip: | ||
- argparse==1.4.0 |
Oops, something went wrong.