Backport #113 #130

ros-controls · Aug 12, 2023 · d66d1a3 · d66d1a3
1 parent 036d500
commit d66d1a3
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 7 deletions.
diff --git a/Makefile b/Makefile
@@ -11,11 +11,14 @@ BUILDDIR      = _build
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS) $(O)
-	@echo ""
-	@echo "make publish"
-	@echo "   publish generated html to thesofproject.github.io site:"
-	@echo "   specify RELEASE=name to publish as a tagged release version"
-	@echo "   and placed in a version subfolder.  Requires repo merge permission."
+	@echo "  html-with-api"
+	@echo "  html-all-subrepos"
+	@echo "  html-all-subrepos-with-errors"
+	@echo "  html-all-subrepos-with-api"
+	@echo "  multiversion"
+	@echo "  multiversion-with-api"
+	@echo "  multiversion-with-errors"
+	@echo "  linkcheck-all-subrepos-with-api"
 
 html-with-api: Makefile
 	@echo Single html file with API
@@ -33,6 +36,15 @@ html-all-subrepos: Makefile
 	@echo Step 3: Deleting subrepositories in doc/ folder
 	./make_help_scripts/delete_sub_repos
 
+html-all-subrepos-with-errors: Makefile
+	@echo Single html file without API
+	@echo Step 1: Cloning all subrepositories
+	./make_help_scripts/add_sub_repos
+	@echo Step 2: Building documentation
+	$(SPHINXBUILD) $(SPHINXOPTS) -W --keep-going $(SOURCEDIR) $(BUILDDIR)/html
+	@echo Step 3: Deleting subrepositories in doc/ folder
+	./make_help_scripts/delete_sub_repos
+
 html-all-subrepos-with-api: Makefile
 	@echo Single html file with API
 	@echo Step 1: Cloning all subrepositories
@@ -44,6 +56,19 @@ html-all-subrepos-with-api: Makefile
 	@echo Step 4: Building API
 	./make_help_scripts/create_api
 
+linkcheck-all-subrepos-with-api: Makefile
+	@echo Single version html file with API and linkcheck
+	@echo Step 1: Cloning all subrepositories
+	./make_help_scripts/add_sub_repos
+	@echo Step 2: Building API
+	./make_help_scripts/create_api
+	@echo Step 3: Cloning all subrepositories again
+	./make_help_scripts/add_sub_repos
+	@echo Step 4: Check links
+	cp -r $(BUILDDIR)/html/doc/api/. doc/api/
+	make linkcheck
+	rm -rf doc/api/
+
 multiversion: Makefile
 	@echo Building multi version documentation without API
 	@echo Step 1: Creating temporary commits
@@ -55,6 +80,17 @@ multiversion: Makefile
 	@echo Step 4: Create correct index
 	@echo "<html><head><meta http-equiv=\"refresh\" content=\"0; url=master/index.html\" /></head></html>" > "$(BUILDDIR)"/html/index.html
 
+multiversion-with-errors: Makefile
+	@echo Building multi version documentation without API
+	@echo Step 1: Creating temporary commits
+	./make_help_scripts/add_tmp_commits
+	@echo Step 2: Build multi version documentation
+	sphinx-multiversion $(SPHINXOPTS) -W --keep-going $(SOURCEDIR) $(BUILDDIR)/html
+	@echo Step 3: Deleting temporary commits
+	./make_help_scripts/delete_tmp_commits
+	@echo Step 4: Create correct index
+	@echo "<html><head><meta http-equiv=\"refresh\" content=\"0; url=master/index.html\" /></head></html>" > "$(BUILDDIR)"/html/index.html
+
 multiversion-with-api: Makefile
 	@echo Building multi version documentation with API
 	@echo Step 1: Creating temporary commits
@@ -68,7 +104,7 @@ multiversion-with-api: Makefile
 	@echo Step 5: Create correct index
 	@echo "<html><head><meta http-equiv=\"refresh\" content=\"0; url=master/index.html\" /></head></html>" > "$(BUILDDIR)"/html/index.html
 
-.PHONY: help Makefile html-with-api multiversion html-with-api
+.PHONY: help Makefile html-with-api multiversion multiversion-with-api multiversion-with-errors html-all-subrepos html-all-subrepos-with-api html-all-subrepos-with-errors linkcheck-all-subrepos-with-api
 
 # TODO(denis): Enable this!
 # # # # Generate the doxygen xml (for Sphinx) and copy the doxygen html to the

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Status
 
-[![Build & Deploy Page](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml/badge.svg)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml)
+[![Build & Deploy Page](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml/badge.svg)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml)[![Sphinx Warnings](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-warnings.yml/badge.svg?branch=master)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-warnings.yml)[![Broken Links](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-links.yml/badge.svg?branch=humble)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-links.yml)
 
 
 # control.ros.org