Skip to content

Commit

Permalink
Merge pull request #59 from SpiNNakerManchester/not-rig-in-docs
Browse files Browse the repository at this point in the history
Purge Rig from places in the docs where it doesn't belong
  • Loading branch information
Christian-B committed Apr 7, 2021
2 parents 390c15a + e8a717f commit 9a3dfa9
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,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/Rig.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Spalloc.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Rig.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Spalloc.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/Rig"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Rig"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Spalloc"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Spalloc"
@echo "# devhelp"

epub:
Expand Down
4 changes: 2 additions & 2 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,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\Rig.qhcp
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Spalloc.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Rig.ghc
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Spalloc.ghc
goto end
)

Expand Down
18 changes: 9 additions & 9 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ def __getattr__(cls, name):
except ImportError:
sys.modules.update({mod_name: Mock()})

AUTHORS = u'Project Rig'
AUTHORS = 'SpiNNaker Team'


#
# Rig documentation build configuration file, created by
# Spalloc documentation build configuration file, created by
# sphinx-quickstart on Tue Jan 20 15:22:07 2015.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -97,8 +97,8 @@ def __getattr__(cls, name):
master_doc = 'index'

# General information about the project.
project = u'Spalloc client'
copyright = u'2016, the Rig Project'
project = 'Spalloc client'
copyright = '2016-2021, the University of Manchester'

# Autodoc should list members in the same order as the source code.
autodoc_member_order = "bysource"
Expand Down Expand Up @@ -320,7 +320,7 @@ def linkcode_resolve(domain, info):
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
# latex_documents = [
# ('index', 'Rig.tex', u'Rig Documentation',
# ('index', 'Spalloc.tex', 'Spalloc Documentation',
# AUTHORS, 'manual'),
# ]

Expand Down Expand Up @@ -350,7 +350,7 @@ def linkcode_resolve(domain, info):
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
# man_pages = [
# ('index', 'rig', u'Rig Documentation',
# ('index', 'spalloc', 'Spalloc Documentation',
# [AUTHORS], 1)
# ]

Expand All @@ -364,9 +364,9 @@ def linkcode_resolve(domain, info):
# (source start file, target name, title, author,
# dir menu entry, description, category)
# texinfo_documents = [
# ('index', 'Rig', u'Rig Documentation',
# AUTHORS, 'Rig',
# 'Tools for mapping problems to SpiNNaker',
# ('index', 'spalloc', 'Spalloc Documentation',
# AUTHORS, 'Spalloc',
# 'Tools for allocating SpiNNaker boards from a deployment',
# 'Miscellaneous'),
# ]

Expand Down

0 comments on commit 9a3dfa9

Please sign in to comment.