Stick with *project* name

(it is assumed to be documentation for a project, so having documentation
in the project name is redundant for sphinx)
This commit is contained in:
Benjamin Melançon 2018-06-17 17:18:26 -04:00
parent 2174974088
commit 2e73eccd41
4 changed files with 77 additions and 1 deletions

20
Makefile Normal file
View file

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = AgaricCollective
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

View file

@ -19,7 +19,7 @@
# -- Project information -----------------------------------------------------
project = u'Agaric Collective public documentation'
project = u'Agaric Collective'
copyright = u'2006—2018, Agaric, LLC'
author = u'Benjamin Melançon, Michele Metts, Mauricio Dinarte, David Valdez, Clayton Dewey'

20
index.rst Normal file
View file

@ -0,0 +1,20 @@
.. Agaric Collective documentation master file, created by
sphinx-quickstart on Sun Jun 17 15:59:15 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Agaric Collective's documentation!
=============================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

36
make.bat Normal file
View file

@ -0,0 +1,36 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=AgaricCollective
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd