Move Sphinx sources to O.Common/rtd-src

Adds the build target 'sphinx' for manual Sphinx runs, and
installs the output of that under $(INSTALL_HTML)/readthedocs

Adjusted some Sphinx config parameters and titles.
This commit is contained in:
Andrew Johnson
2024-08-24 21:45:13 -05:00
parent be4d1604ba
commit af206ba7fc
4 changed files with 15 additions and 12 deletions

View File

@ -134,7 +134,7 @@ HEADER_RST_FILES = $(foreach t, $(HEADER_TYPES), \
$(addsuffix _h.rst, $($t_HEADERS)))
API_RST_FILES = $(addsuffix -api.rst, $(HEADER_TYPES))
RTD_SRC = rtd-src
RTD_SRC = $(COMMON_DIR)/rtd-src
DOCS += README.md
DOCS += RELEASE_NOTES.md
@ -152,7 +152,7 @@ $(API_RST_FILES): %-api.rst: ../%-API.rst
echo " $h_h.rst" >> $@;)
ifndef T_A
doxygen rtd: inc
doxygen rtd sphinx: inc
$(MAKE) -C O.$(EPICS_HOST_ARCH) $@
else
@ -165,7 +165,10 @@ rtd: doxygen $(API_RST_FILES) $(HEADER_RST_FILES)
rsync -av $(HEADER_RST_FILES) $(RTD_SRC)/
rsync -av $(API_RST_FILES) $(RTD_SRC)/
rsync -av ../index.rst ../conf.py $(RTD_SRC)/
$(PYTHON) -m sphinx rtd-src _readthedocs/html
sphinx: rtd
cd $(COMMON_DIR); $(PYTHON) -m sphinx rtd-src readthedocs
rsync -av $(COMMON_DIR)/readthedocs $(INSTALL_HTML)/
endif
.PHONY: doxygen rtd
.PHONY: doxygen rtd sphinx

View File

@ -17,9 +17,9 @@ sys.path.insert(0, os.path.abspath("."))
# -- Project information -----------------------------------------------------
project = "EPICS base documentation"
project = "EPICS Base Documentation"
copyright = "EPICS Controls"
author = "EPICS"
author = "The EPICS Collaboration"
# -- General configuration ---------------------------------------------------
@ -50,7 +50,7 @@ primary_domain = "cpp"
highlight_language = "cpp"
# Add any paths that contain templates here, relative to this directory.
templates_path = ["../modules/libcom/src/cxxTemplates"]
# templates_path = ()
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.

View File

@ -1,11 +1,11 @@
EPICS Document Collection
=========================
EPICS Base Documentation
========================
.. toctree::
:hidden:
Back <https://docs.epics-controls.org/en/latest/>
EPICS Documentation Index <https://docs.epics-controls.org/en/latest/>
.. toctree::
:maxdepth: 1