Skip to content

Commit

Permalink
update to sphinx documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bertinia committed Sep 12, 2017
1 parent 8f99626 commit d4a9ede
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 472 deletions.
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Tools_api:
@$(SPHINXAPI) --force -o $(SOURCEDIR)/$@ $(SCRIPTSDIR)/Tools

Tools_user:
rm $(SOURCEDIR)/$@/*.rst
rm -f $(SOURCEDIR)/$@/*.rst
./tools_autodoc.py

.PHONY: help Makefile CIME_api Tools_api Tools_user
Expand Down
16 changes: 0 additions & 16 deletions doc/source/glossary.rst

This file was deleted.

6 changes: 2 additions & 4 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Table of contents
data_models/index.rst
driver_cpl/index.rst
misc_tools/index.rst
glossary.rst

Addendum
---------
Expand All @@ -34,12 +33,11 @@ Addendum
CIME_api/modules.rst
Tools_api/modules.rst

Indices, Glossary and Search
----------------------------
Python Module Indices and Search
---------------------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`glossary`
* :ref:`search`


Expand Down
2 changes: 0 additions & 2 deletions doc/source/users_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ CIME User's Guide Part 1: Beginner - Basic Usage
cloning-a-case.rst
troubleshooting.rst


.. _users-guide2:

#######################################################################################
Expand All @@ -42,7 +41,6 @@ CIME User's Guide Part 2: Intermediate - CIME Internals, Porting, Testing and Us
multi-instance.rst
adding-cases.rst
use_cases/use-cases.rst
adding-components.rst


Indices and tables
Expand Down
1 change: 1 addition & 0 deletions doc/source/users_guide/multi-instance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ As a result, you will have two instances of CAM, CLM and CICE (prescribed), RTM,
Now consider the multi driver model.
To use this mode change
::

> ./xmlchange MULTI_DRIVER=TRUE

This configuration will run each component instance on the original 144 tasks but will generate two copies of the model (in the same executable) for a total of 288 tasks.
Expand Down
6 changes: 3 additions & 3 deletions doc/source/xml_files/cesm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ the following XML files.

CESM XML settings for all-active component set (compset) configurations.

.. literalinclude:: ../../../cime_config/config_compsets.xml
.. literalinclude:: ../../../../cime_config/config_compsets.xml

CESM XML settings for all-active test configurations.

.. literalinclude:: ../../../cime_config/testlist_allactive.xml
.. literalinclude:: ../../../../cime_config/testlist_allactive.xml

CESM XML settings for optimized processor elements (PEs) layout configurations.

.. literalinclude:: ../../../cime_config/config_pes.xml
.. literalinclude:: ../../../../cime_config/config_pes.xml

Loading

0 comments on commit d4a9ede

Please sign in to comment.