Setup a fresh documentation

Set up a fresh sphinx-based documentation stub under docs/ subdir.
Re-use some bits like sphinx config from the old docs/ directory.

Author: marquiz

.github/workflows/publish-docs.yml

@@ -20,8 +20,9 @@ jobs:
     - name: Add latest generated docs to gh-pages
       shell: bash
       run: |
-        touch _build/html/.nojekyll
-        git --work-tree _build/html add --no-all -v .
+        touch _build/.nojekyll
+        rm -rf _build/.doctrees _build/_sources
+        git --work-tree _build add --no-all -v .
         author=$(git log --merges --pretty=format:%an -n 1)
         email=$(git log --merges --pretty=format:%ae -n 1)
         git config --global user.name "$author"

Makefile

@@ -78,6 +78,7 @@ BUILD_BUILDID := $(shell scripts/build/get-buildid --buildid --shell=no)
 RPM_VERSION   := $(shell scripts/build/get-buildid --rpm --shell=no)
 DEB_VERSION   := $(shell scripts/build/get-buildid --deb --shell=no)
 TAR_VERSION   := $(shell scripts/build/get-buildid --tar --shell=no)
+SITE_VERSION  := $(shell scripts/build/get-buildid --site --shell=no)
 
 # Kubernetes version we pull in as modules and our external API versions.
 KUBERNETES_VERSION := $(shell grep 'k8s.io/kubernetes ' go.mod | sed 's/^.* //')
@@ -643,24 +644,24 @@ BUILDDIR      = _build
 
 vhtml: _work/venv/.stamp
 	. _work/venv/bin/activate && \
-		$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) && \
-		cp docs/html/index.html $(BUILDDIR)/html/index.html
+		make -C docs html && \
+		cp -r docs/_build .
 
 html:
-		$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) && \
-		cp docs/html/index.html $(BUILDDIR)/html/index.html
+	$(SPHINXBUILD) -c docs . "$(BUILDDIR)" $(SPHINXOPTS)
+	cp docs/index.html "$(BUILDDIR)"
 
 clean-html:
-	rm -rf $(BUILDDIR)/html
+	rm -rf $(BUILDDIR)/*
 
 site-build: .$(DOCKER_SITE_BUILDER_IMAGE).image.stamp
 	$(Q)$(DOCKER_SITE_CMD) make html
 
 site-serve: .$(DOCKER_SITE_BUILDER_IMAGE).image.stamp
-	$(Q)$(DOCKER_SITE_CMD) bash -c "make html && cd _build/html && python3 -m http.server 8081"
+	$(Q)$(DOCKER_SITE_CMD) bash -c "make html && cd _build && python3 -m http.server 8081"
 
-.$(DOCKER_SITE_BUILDER_IMAGE).image.stamp: docs/Dockerfile
-	docker build -t $(DOCKER_SITE_BUILDER_IMAGE) -f docs/Dockerfile .
+.$(DOCKER_SITE_BUILDER_IMAGE).image.stamp: docs/Dockerfile docs/requirements.txt
+	docker build -t $(DOCKER_SITE_BUILDER_IMAGE) docs
 	touch $@
 
 # Set up a Python3 environment with the necessary tools for document creation.

docs-old/requirements.txt

@@ -1,5 +1,5 @@
 FROM sphinxdoc/sphinx:3.2.1
 
-COPY docs/requirements.txt .
+COPY requirements.txt .
 
 RUN pip3 install -r requirements.txt

docs-old/Dockerfile renamed to docs/Dockerfile

@@ -24,6 +24,7 @@
 copyright = '2020, various'
 author = 'various'
 
+master_doc = 'docs/index'
 
 ##############################################################################
 #
@@ -47,9 +48,9 @@
 ##############################################################################
 
 baseBranch = "master"
-useGitHubURL = True
+useGitHubURL = False
 commitSHA = getenv('GITHUB_SHA')
-githubBaseURL = "https://github.com/intelkevinputnam/cri-resource-manager/"
+githubBaseURL = "https://github.com/intel/cri-resource-manager/"
 githubFileURL = githubBaseURL + "blob/"
 githubDirURL = githubBaseURL + "tree/"
 if commitSHA:
@@ -74,7 +75,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store','_work']
+exclude_patterns = ['_build', '_work', 'README.md', 'RELEASE.md']
 
 
 # -- Options for HTML output -------------------------------------------------

conf.py renamed to docs/conf.py

@@ -0,0 +1 @@
+<meta http-equiv="refresh" content="0; URL='docs/index.html'" />

docs/index.html

@@ -0,0 +1,10 @@
+.. CRI Resource Manager documentation master file
+
+Welcome to CRI Resource Manager's documentation!
+================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   Project GitHub repository <https://github.com/intel/cri-resource-manager>

docs/index.rst

@@ -0,0 +1,4 @@
+sphinx==3.2.1
+sphinx_rtd_theme
+recommonmark
+sphinx-markdown-tables