Skip to content

Commit 82bbd1f

Browse files
authored
Merge pull request #976 from billsacks/doc_source_release
Bring documentation source to clm5.0 release branch
2 parents 72a2987 + 0380be4 commit 82bbd1f

File tree

158 files changed

+28491
-10504
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

158 files changed

+28491
-10504
lines changed

.gitattributes

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*.svg filter=lfs diff=lfs merge=lfs -text
2+
*.png filter=lfs diff=lfs merge=lfs -text
3+
*.jpg filter=lfs diff=lfs merge=lfs -text
4+
*.jpeg filter=lfs diff=lfs merge=lfs -text
5+
*.gif filter=lfs diff=lfs merge=lfs -text
6+
*.pdf filter=lfs diff=lfs merge=lfs -text

.lfsconfig

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[lfs]
2+
fetchexclude = *

doc/Makefile

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = clmdoc
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
# Before building html or pdf, obtain all of the images. This is needed
16+
# because we have configured this repository (via an .lfsconfig file at
17+
# the top level) to NOT automatically fetch any of the large files when
18+
# cloning / fetching.
19+
html: fetch-images
20+
latexpdf: fetch-images
21+
fetch-images:
22+
git lfs pull --exclude=""
23+
24+
.PHONY: help fetch-images Makefile
25+
26+
# For the pdf, we only build the tech note, but use the conf.py file in
27+
# the top-level source directory (the -c option says where to find
28+
# conf.py). Note that we also override the setting of
29+
# numfig_secnum_depth in order to have figure numbering as desired in
30+
# the pdf, given that the pdf just contains the tech note, so doesn't
31+
# have the top-level numbering present in the web documentation (where
32+
# top-level section 1 is the User's Guide and section 2 is the Tech
33+
# Note).
34+
#
35+
# The use of $(0) is as in the catch-all target.
36+
latexpdf:
37+
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)/tech_note" "$(BUILDDIR)" -c "$(SOURCEDIR)" -D numfig_secnum_depth=1 $(SPHINXOPTS) $(O)
38+
39+
# Catch-all target: route all unknown targets to Sphinx using the new
40+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
41+
%: Makefile
42+
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/UsersGuide/Makefile

Lines changed: 0 additions & 193 deletions
This file was deleted.

doc/UsersGuide/addco2_datm.buildnml.diff

Lines changed: 0 additions & 59 deletions
This file was deleted.

0 commit comments

Comments
 (0)