Skip to content

Commit

Permalink
Merge pull request #976 from billsacks/doc_source_release
Browse files Browse the repository at this point in the history
Bring documentation source to clm5.0 release branch
  • Loading branch information
ekluzek authored Apr 20, 2020
2 parents 72a2987 + 0380be4 commit 82bbd1f
Show file tree
Hide file tree
Showing 158 changed files with 28,491 additions and 10,504 deletions.
6 changes: 6 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*.svg filter=lfs diff=lfs merge=lfs -text
*.png filter=lfs diff=lfs merge=lfs -text
*.jpg filter=lfs diff=lfs merge=lfs -text
*.jpeg filter=lfs diff=lfs merge=lfs -text
*.gif filter=lfs diff=lfs merge=lfs -text
*.pdf filter=lfs diff=lfs merge=lfs -text
2 changes: 2 additions & 0 deletions .lfsconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[lfs]
fetchexclude = *
42 changes: 42 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = clmdoc
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

# Before building html or pdf, obtain all of the images. This is needed
# because we have configured this repository (via an .lfsconfig file at
# the top level) to NOT automatically fetch any of the large files when
# cloning / fetching.
html: fetch-images
latexpdf: fetch-images
fetch-images:
git lfs pull --exclude=""

.PHONY: help fetch-images Makefile

# For the pdf, we only build the tech note, but use the conf.py file in
# the top-level source directory (the -c option says where to find
# conf.py). Note that we also override the setting of
# numfig_secnum_depth in order to have figure numbering as desired in
# the pdf, given that the pdf just contains the tech note, so doesn't
# have the top-level numbering present in the web documentation (where
# top-level section 1 is the User's Guide and section 2 is the Tech
# Note).
#
# The use of $(0) is as in the catch-all target.
latexpdf:
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)/tech_note" "$(BUILDDIR)" -c "$(SOURCEDIR)" -D numfig_secnum_depth=1 $(SPHINXOPTS) $(O)

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
193 changes: 0 additions & 193 deletions doc/UsersGuide/Makefile

This file was deleted.

59 changes: 0 additions & 59 deletions doc/UsersGuide/addco2_datm.buildnml.diff

This file was deleted.

Loading

0 comments on commit 82bbd1f

Please sign in to comment.