diff --git a/.gitignore b/.gitignore index 98f8fbcef2..1cfb3cfd05 100644 --- a/.gitignore +++ b/.gitignore @@ -14,7 +14,7 @@ doc/* !doc/joss-paper # derived files -src/appendices/command-ref.rst +src/reference/command-help.rst # editor stuff *.swp diff --git a/Makefile b/Makefile index 930b63b33b..8b78a91e7f 100644 --- a/Makefile +++ b/Makefile @@ -21,6 +21,7 @@ clean: # remove auto-generated content rm -rf src/plugins/main-loop/built-in rm -rf src/user-guide/task-implementation/job-runner-handlers + rm -rf src/reference/command-help.rst cleanall: (cd doc; echo [0-9]*.*) @@ -32,6 +33,8 @@ cleanall: # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # NOTE: EXPORT_ALL_VARIABLES exports make vars as env vars %: Makefile .EXPORT_ALL_VARIABLES + # generate command help transcripts + bin/autodoc-cli # build documentation @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) # write out dict of available versions and formats diff --git a/bin/autodoc-cli b/bin/autodoc-cli index 57197ee33d..0543f242b0 100755 --- a/bin/autodoc-cli +++ b/bin/autodoc-cli @@ -15,11 +15,10 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -# Create appendices/command-ref.rst for inclusion in HTML doc. +# Create command help transcripts for inclusion in HTML doc. # All paths relative to 'doc/src/custom/' directory: -COMMAND_REF_FILE="$(dirname "$0")/../src/appendices/command-ref.rst" -CYLC="cylc" +COMMAND_REF_FILE="$(dirname "$0")/../src/reference/command-help.rst" cat > "$COMMAND_REF_FILE" < "$COMMAND_REF_FILE" <> "$COMMAND_REF_FILE" <> "$COMMAND_REF_FILE" <> "$COMMAND_REF_FILE" <