Compare commits

...

3 Commits

Author SHA1 Message Date
Jeff Moe 46216ab9ef v0.0.6 2023-11-24 21:38:18 -07:00
Jeff Moe a9e5a38ef4 Read the docs theme 2023-11-24 21:37:40 -07:00
Jeff Moe a5526cfe29 dont need no bats 2023-11-24 21:36:45 -07:00
4 changed files with 12 additions and 46 deletions

View File

@ -1,3 +1,4 @@
v0.0.6 Read the Docs Sphinx for The Smack.
v0.0.5 Sphinx docs for The Smack. v0.0.5 Sphinx docs for The Smack.
v0.0.4 The Stack scriplet to generate license list. v0.0.4 The Stack scriplet to generate license list.
v0.0.3 The Smack started. v0.0.3 The Smack started.

View File

@ -1,35 +0,0 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
%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.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

View File

@ -6,25 +6,24 @@
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'The Smack' project = "The Smack"
copyright = '2023, Jeff Moe' copyright = "2023, Jeff Moe"
author = 'Jeff Moe' author = "Jeff Moe"
release = 'v0.0.5' release = "v0.0.6"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [ extensions = [
'sphinx.ext.autodoc', "sphinx.ext.autodoc",
] ]
templates_path = ['_templates'] templates_path = ["_templates"]
exclude_patterns = ['_build'] exclude_patterns = ["_build"]
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'alabaster' html_theme = "sphinx_rtd_theme"
html_static_path = ['_static'] html_static_path = ["_static"]
htmlhelp_basename = 'TheStackLicensesdoc' htmlhelp_basename = "TheStackLicensesdoc"

View File

@ -5,3 +5,4 @@ pathlib
termcolor termcolor
pytest pytest
sphinx sphinx
sphinx_rtd_theme