Skip to content

Commit 758a5b8

Browse files
committed
Update doc README
Add pip install commands, remove some pieces that are no longer correct.
1 parent 50bdb88 commit 758a5b8

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

doc/README

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11

2-
This requires Sphinx v1.7 or greater.
2+
This requires Sphinx v1.7 or greater, as well as some add-ons, which can
3+
be installed with:
4+
5+
pip install sphinx
6+
pip install sphinxcontrib-programoutput
7+
pip install git+https://github.com/esmci/sphinx_rtd_theme.git@version-dropdown-with-fixes
38

49
Check the sphinx version as follows:
510

611
>sphinx-build --version
712

813
The documentation source is stored with the CIME master code base. However,
9-
the built html files are stored seperately in the orphan gh-pages branch
14+
the built html files are stored separately in the orphan gh-pages branch
1015
and can be viewed from a browser at URL:
1116

1217
http://esmci.github.io/cime
@@ -19,17 +24,10 @@ https://github.com/ESMCI/cime/wiki/Working-with-Sphinx-and-reStructuredText
1924
Use the following commands to auto-build the html documentation from the main
2025
cime/doc directory:
2126

22-
>make clean
23-
>make api
24-
>make html
25-
26-
To copy the html to the orphan gh-pages, follow these steps:
27-
28-
>git clone -b gh-pages https://github.com/ESMCI/cime.git cime.gh-pages
29-
>cd cime.gh-pages
30-
>rm -rf *
31-
>cp -R /path/to/cime-master/doc/build/html/* .
32-
>git commit -m 'update HTML for PR #...'
33-
>git push origin gh-pages
34-
27+
make clean
28+
make api
29+
make html
3530

31+
To publish the docs to the orphan gh-pages branch, follow the steps in
32+
https://github.com/ESMCI/cime/wiki/Working-with-Sphinx-and-reStructuredText
33+
to ensure proper versioning of the documentation.

0 commit comments

Comments
 (0)