Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

minor update to sphinx documentation #1883

Merged
merged 4 commits into from
Sep 12, 2017
Merged

minor update to sphinx documentation #1883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ed2406
Update README
bertinia Aug 28, 2017
f367515
upstream ESMCI/CIME master merge
bertinia Sep 11, 2017
8f99626
Merge branch 'master' of https://github.com/bertinia/cime
bertinia Sep 12, 2017
d4a9ede
update to sphinx documentation
bertinia Sep 12, 2017
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: 1 addition & 1 deletion doc/Makefile
View file
Open in desktop
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
View file
Open in desktop

This file was deleted.

6 changes: 2 additions & 4 deletions doc/source/index.rst
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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