Skip to content
Snippets Groups Projects
Verified Commit 1086fe1d authored by James Graham's avatar James Graham
Browse files

docs: move to Sphinx config without subdirs

parent 14d5d9ab
Branches
Tags
No related merge requests found
...@@ -20,7 +20,7 @@ poetry.toml ...@@ -20,7 +20,7 @@ poetry.toml
.python-version .python-version
/cover/ /cover/
/dist/ /dist/
/docs/build/ /docs/_build/
/pycgtool.egg-info/ /pycgtool.egg-info/
/tmp/ /tmp/
......
...@@ -5,8 +5,8 @@ ...@@ -5,8 +5,8 @@
# from the environment for the first two. # from the environment for the first two.
SPHINXOPTS ?= SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build SPHINXBUILD ?= sphinx-build
SOURCEDIR = source SOURCEDIR = .
BUILDDIR = build BUILDDIR = _build
# Put it first so that "make" without argument is like "make help". # Put it first so that "make" without argument is like "make help".
help: help:
......
...@@ -18,13 +18,12 @@ ...@@ -18,13 +18,12 @@
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'PyCGTOOL' project = 'PyCGTOOL'
copyright = '2020, James Graham' copyright = '2016, James Graham'
author = 'James Graham' author = 'James Graham'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = '2.0.0' release = '2.0.0'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
...@@ -34,15 +33,19 @@ extensions = [ ...@@ -34,15 +33,19 @@ extensions = [
'autoapi.extension', 'autoapi.extension',
'sphinx_rtd_theme', 'sphinx_rtd_theme',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
# 'recommonmark',
'm2r2',
] ]
source_suffix = ['.rst', '.md']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
...@@ -57,7 +60,8 @@ html_theme = 'sphinx_rtd_theme' ...@@ -57,7 +60,8 @@ html_theme = 'sphinx_rtd_theme'
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
# -- Sphinx AudoAPI options -------------------------------------------------- # -- Sphinx AudoAPI options --------------------------------------------------
autoapi_type = 'python' autoapi_type = 'python'
autoapi_dirs = ['../../pycgtool'] autoapi_dirs = ['../pycgtool']
File moved
...@@ -7,8 +7,8 @@ REM Command file for Sphinx documentation ...@@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" ( if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build set SPHINXBUILD=sphinx-build
) )
set SOURCEDIR=source set SOURCEDIR=.
set BUILDDIR=build set BUILDDIR=_build
if "%1" == "" goto help if "%1" == "" goto help
......
File moved
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment