diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index dca4e4bdfbb25b83c1feec8987a1ba8c87ad0795..1e15bb4c6abb7e39da0d6a40e48b4717c17e1041 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -171,6 +171,7 @@ review-docs: - mv _build/html/ ../../public - cd ../user-guide && make build - mv _build/html/ ../../public/user + - cd ../ && cp index.html ../public/ artifacts: paths: - public @@ -216,6 +217,7 @@ pages: - mv _build/html/ ../../public - cd ../user-guide && make build - mv _build/html/ ../../public/user + - cd ../ && cp index.html ../public/ variables: LATEST_VERSION: 1.4.6 DOCS_VERSIONS: ($LATEST_VERSION|1.2.0|1.1.1|1.0.0) diff --git a/documentation/index.html b/documentation/index.html new file mode 100644 index 0000000000000000000000000000000000000000..b76cce630ff58e2c9a518121d14ac67b3646120d --- /dev/null +++ b/documentation/index.html @@ -0,0 +1,16 @@ + + + + + + + View Server Documentation + + +

View Server Documentation

+ + + diff --git a/documentation/operator-guide/Makefile b/documentation/operator-guide/Makefile index 545d0b54be8be78f8d3998fede3115c14ccff861..3124c38d7c2f9063eb67e284c3e548cc0573c2ac 100644 --- a/documentation/operator-guide/Makefile +++ b/documentation/operator-guide/Makefile @@ -19,8 +19,19 @@ help: html-watch: @$(SPHINXAUTOBUILD) -i "$(BUILDDIR)/*" "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O) +html: + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +latexpdf: + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + gs -sDEVICE=pdfwrite -dPDFSETTINGS=/ebook -dPrinted=false -q -o _build/latex/View-Server_-_Operator-Guide_small.pdf _build/latex/View-Server_-_Operator-Guide.pdf + build: + # just do html and latexpdf combined @$(SPHINXMULTIBUILD) "$(SOURCEDIR)" "$(BUILDDIR)/html" + @$(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + gs -sDEVICE=pdfwrite -dPDFSETTINGS=/ebook -dPrinted=false -q -o _build/latex/View-Server_-_Operator-Guide_small.pdf _build/latex/View-Server_-_Operator-Guide.pdf + rsync -rpE _build/latex/View-Server_-_Operator-Guide_small.pdf _build/html/View-Server_-_Operator-Guide.pdf # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). diff --git a/documentation/operator-guide/index.rst b/documentation/operator-guide/index.rst index 21443f7e84fe9ba5aec0ef6034d9ef2d6290a361..c582037b547c874fdbf0611e386e236ac066a748 100644 --- a/documentation/operator-guide/index.rst +++ b/documentation/operator-guide/index.rst @@ -4,7 +4,9 @@ View Server - Operator Guide ============================ -This is the documentation for operators of the View Server. The user documentation can +This is the documentation for operators of the View Server. The PDF format of this +documentation for the latest version is located +`here <../View-Server_-_Operator-Guide.pdf>`_. The user documentation can be found `here <../user/master/index.html>`_. View Server - Contents