html docs build

Author: RussBerg

.github/workflows/ci.yaml

@@ -47,47 +47,43 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Deploy Information
-        if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
-        run: |
-          echo "The HTML NeXus Wiki will be pushed to"
-          echo " https://github.com/nexusformat/wiki/tree/gh-pages"
-          echo "The HTML NeXus Wiki will be deployed on"
-          echo " https://nexusformat.github.io/wiki/"
+#      - name: Deploy Information
+#        if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
+#        run: |
+#          echo "The HTML NeXus Wiki will be pushed to"
+#          echo " https://github.com/nexusformat/wiki/tree/gh-pages"
+#          echo "The HTML NeXus Wiki will be deployed on"
+#          echo " https://nexusformat.github.io/wiki/"
 
       - name: Install Requirements
         run: |
           python3 -m pip install --upgrade pip setuptools
           make install
           python3 -m pip list
 
-      - name: Check Code Style
-        run: |
-          make style
-
-      - name: Install LaTeX
-        run: |
-          sudo apt-get update -y && \
-          sudo apt-get install -y \
-            latexmk \
-            texlive-latex-recommended \
-            texlive-latex-extra \
-            texlive-fonts-recommended
-          tex --version
-
-      - name: Generate build files
-        env:
-          GH_TOKEN: ${{ (env.python_version == env.python_deploy_version && (github.event.inputs.deploy || github.event.inputs.upload)) || 'NONE' }}
-        run: |
-          make prepare
+#      - name: Install LaTeX
+#        run: |
+#          sudo apt-get update -y && \
+#          sudo apt-get install -y \
+#            latexmk \
+#            texlive-latex-recommended \
+#            texlive-latex-extra \
+#            texlive-fonts-recommended
+#          tex --version
 
+#      - name: Build Wiki
+#        run: |
+#          make pdf
+#          make html
+#          ls -lAFgh build/manual/build/html/index.html
+#          mkdir -p build/html
+#          mv build/manual/build/html/* build/html
       - name: Build Wiki
         run: |
-          make pdf
           make html
-          ls -lAFgh build/manual/build/html/index.html
+          ls -lAFgh wiki/source/build/html/index.html
           mkdir -p build/html
-          mv build/manual/build/html/* build/html
+          mv wiki/source/build/html/* build/html
 
 #      - name: Deploy Wiki
 #        if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}

Makefile

@@ -1,7 +1,7 @@
 # File: Makefile
 
 # purpose:
-#	build resources in NeXus definitions tree
+#	build resources in NeXus Wiki
 
 PYTHON = python3
 SPHINX = sphinx-build
@@ -15,13 +15,10 @@ help ::
 	@echo ""
 
 	@echo "make install            Install all requirements to run tests and builds."
-	@echo "make style              Check python coding style."
-	@echo "make autoformat         Format all files to the coding style conventions."
-	@echo "make test               Run documentation tests."
 	@echo "make clean              Remove all build files."
-	@echo "make prepare            (Re)create all build files."
+#	@echo "make prepare            (Re)create all build files."
 	@echo "make html               Build HTML version of manual. Requires prepare first."
-	@echo "make pdf                Build PDF version of manual. Requires prepare first."
+#	@echo "make pdf                Build PDF version of manual. Requires prepare first."
 	@echo "make fetch-logo         Copy the official logo files from the manual repository."
 	@echo "make all                Builds complete web site for the wiki (in build directory)."
 	@echo "make local              (Developer use) Test, prepare and build the HTML wiki."
@@ -35,32 +32,22 @@ help ::
 install ::
 	$(PYTHON) -m pip install -r requirements.txt
 
-style ::
-	$(PYTHON) -m black --check dev_tools
-	$(PYTHON) -m flake8 dev_tools
-	$(PYTHON) -m isort --check dev_tools
-
-autoformat ::
-	$(PYTHON) -m black dev_tools
-	$(PYTHON) -m isort dev_tools
-
 clean ::
 	$(RM) -rf ./wiki/source/$(BUILD_DIR)
 
-prepare ::
-	$(PYTHON) -m dev_tools wiki --prepare --build-root $(BUILD_DIR)
+#prepare ::
+#	$(PYTHON) -m wiki --prepare --build-root $(BUILD_DIR)
 
-# pdf ::
-# 	$(SPHINX) -M latexpdf $(BUILD_DIR)/wiki/source/ $(BUILD_DIR)/wiki/build
-# 	cp $(BUILD_DIR)/manual/build/latex/nexus.pdf $(BUILD_DIR)/wiki/source/_static/NeXusManual.pdf
+pdf ::
+	$(SPHINX) -M latexpdf ./wiki/source/ ./wiki/$(BUILD_DIR)
+	cp $(BUILD_DIR)/wiki/build/latex/nexus.pdf $(BUILD_DIR)/wiki/source/_static/NeXusWiki.pdf
 
 html: fetch-logo
 	$(SPHINX) -b html -W ./wiki/source/ ./wiki/source/$(BUILD_DIR)/html
 
 # for developer's use on local build host
 local ::
-	$(MAKE) test
-	$(MAKE) prepare
+#	$(MAKE) prepare
 	$(MAKE) html
 
 fetch-logo:
@@ -71,10 +58,10 @@ fetch-logo:
 
 all ::
 	$(MAKE) clean
-	$(MAKE) prepare
-	$(MAKE) pdf
+#	$(MAKE) prepare
+#	$(MAKE) pdf
 	$(MAKE) html
-	@echo "HTML built: `ls -lAFgh $(BUILD_DIR)/wiki/build/html/index.html`"
+	@echo "HTML built: `ls -lAFgh wiki/build/html/index.html`"
 
 
 
@@ -98,4 +85,4 @@ all ::
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 #
-# For further information, see http://www.nexusformat.org
+# For further information, see http://www.nexusformat.org

wiki/source/conf.py

@@ -72,7 +72,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 # html_extra_path = ['md']
 
 # Add extra files