Skip to content

Commit

Permalink
version: Update Sphinx config under man (#2967)
Browse files Browse the repository at this point in the history
Version is updated to 8.4 and references to version are reduced. Word documentation is removed from names. Related duplicated values are reused using variables.
  • Loading branch information
wenzeslaus committed May 22, 2023
1 parent 2c2e5b5 commit 6048bac
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 23 deletions.
8 changes: 4 additions & 4 deletions man/sphinx/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GRASS83Documentation.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/grass_gis.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GRASS83Documentation.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/grass_gis.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/GRASS83Documentation"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GRASS83Documentation"
@echo "# mkdir -p $$HOME/.local/share/devhelp/grass_gis"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/grass_gis"
@echo "# devhelp"

epub:
Expand Down
34 changes: 17 additions & 17 deletions man/sphinx/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#
# GRASS GIS 8.3 Documentation documentation build configuration file, created by
# sphinx-quickstart on Thu Aug 9 17:16:28 2012.
# GRASS GIS Python documentation build configuration file
# originally created by sphinx-quickstart.
#
# This file is execfile()d with the current directory set to its containing dir.
#
Expand All @@ -22,7 +22,7 @@

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ["sphinx.ext.todo", "sphinx.ext.pngmath"]
extensions = ["sphinx.ext.todo", "sphinx.ext.imgmath"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand All @@ -37,15 +37,15 @@
master_doc = "index"

# General information about the project.
project = "GRASS GIS 8.3 Documentation"
project = "GRASS GIS"
copyright = "2023, GRASS Development Team"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = "8.3"
version = "8.4"
# The full version, including alpha/beta/rc tags.
release = "dev"

Expand Down Expand Up @@ -161,7 +161,7 @@
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = "grass83Documentationdoc"
htmlhelp_basename = "grass_gis"


# -- Options for LaTeX output --------------------------------------------------
Expand All @@ -180,8 +180,8 @@
latex_documents = [
(
"content",
"grass83Documentation.tex",
"GRASS GIS 8.3 Documentation",
"grass_gis.tex",
project,
"GRASS Development Team",
"manual",
),
Expand Down Expand Up @@ -215,8 +215,8 @@
man_pages = [
(
"content",
"grass83documentation",
"GRASS GIS 8.3 Documentation",
"grass_gis",
project,
["GRASS Development Team"],
1,
)
Expand All @@ -234,11 +234,11 @@
texinfo_documents = [
(
"content",
"grass83Documentation",
"GRASS GIS 8.3 Documentation",
"grass_gis",
project,
"GRASS Development Team",
"grass83Documentation",
"One line description of project.",
"grass_gis",
"Documentation for GRASS GIS in Sphinx",
"Miscellaneous",
),
]
Expand All @@ -256,10 +256,10 @@
# -- Options for Epub output ---------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = "GRASS GIS 8.3 Documentation"
epub_title = project
epub_author = "GRASS Development Team"
epub_publisher = "GRASS Development Team"
epub_copyright = "2023, GRASS Development Team"
epub_publisher = epub_author
epub_copyright = copyright

# The language of the text. It defaults to the language option
# or en if the language is not set.
Expand Down
4 changes: 2 additions & 2 deletions man/sphinx/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ if "%1" == "qthelp" (
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\GRASS83Documentation.qhcp
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\grass_gis.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\GRASS83Documentation.ghc
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\grass_gis.ghc
goto end
)

Expand Down

0 comments on commit 6048bac

Please sign in to comment.