Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ __pycache__/
/demos/**/*.py
/docs/build/
/docs/source/demos
/docs/source/generated
15 changes: 9 additions & 6 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ BUILDDIR = build

GENERATED_FILES = source/demos/* source/generated/*

.PHONY: help Makefile clean copy_demos
.PHONY: help Makefile clean copy_demos linkcheck

# Put it first so that "make" without argument is like "make help".
help:
Expand All @@ -22,16 +22,19 @@ clean:
rm -r $(GENERATED_FILES)

copy_demos:
install -d source/demos
cp ../demos/*/*.rst source/demos
for file in source/demos/*.py.rst; do pylit $$file; done
install -d $(SOURCEDIR)/demos
cp ../demos/*/*.rst $(SOURCEDIR)/demos
for file in $(SOURCEDIR)/demos/*.py.rst; do pylit $$file; done

apidoc: copy_demos
sphinx-apidoc --force --no-toc --module-first -o "$(SOURCEDIR)" ../fdvar
sphinx-apidoc --force --no-toc --module-first -o $(SOURCEDIR)/generated ../fdvar

linkcheck: apidoc
@$(SPHINXBUILD) -b linkcheck $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/linkcheck

html: Makefile copy_demos
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" $(BUILDDIR) $(SPHINXOPTS) $(O)
cp source/demos/*.py $(BUILDDIR)/$@/demos/
cp $(SOURCEDIR)/demos/*.py $(BUILDDIR)/$@/demos/

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
34 changes: 0 additions & 34 deletions docs/source/generated/fdvar.adjoint.rst

This file was deleted.

34 changes: 0 additions & 34 deletions docs/source/generated/fdvar.preconditioners.rst

This file was deleted.

59 changes: 0 additions & 59 deletions docs/source/generated/fdvar.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/generated/modules.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Getting in touch
----------------

Please get in touch with any questions related to ``fdvar`` by raising an issue on the `GitHub repository <https://github.com/firedrakeproject/fdvar/>`_.
For more general Firedrake queries please see the `Firedrake contact page <https://www.firedrakeproject.org/contact/>`_
For more general Firedrake queries please see the `Firedrake contact page <https://www.firedrakeproject.org/contact.html>`_

Contributors
------------
Expand Down
Loading