diff --git a/.gitignore b/.gitignore index 2b742f2dd9b583c54f7435bfd96a56c174211197..fca79a31a1efdbdacbd427ce79f5363a554454b7 100644 --- a/.gitignore +++ b/.gitignore @@ -20,7 +20,7 @@ poetry.toml .python-version /cover/ /dist/ -/docs/build/ +/docs/_build/ /pycgtool.egg-info/ /tmp/ diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf1020d5c292abdedf27627c6abe25e2293..d4bb2cbb9eddb1bb1b4f366623044af8e4830919 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,8 +5,8 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build +SOURCEDIR = . +BUILDDIR = _build # Put it first so that "make" without argument is like "make help". help: diff --git a/docs/source/conf.py b/docs/conf.py similarity index 91% rename from docs/source/conf.py rename to docs/conf.py index 6478d813215cd773078ae1ff30b058e5ca9ecbef..c09544f8e830f427a3e89e7778b893ca9b553a08 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -18,13 +18,12 @@ # -- Project information ----------------------------------------------------- project = 'PyCGTOOL' -copyright = '2020, James Graham' +copyright = '2016, James Graham' author = 'James Graham' # The full version, including alpha/beta/rc tags release = '2.0.0' - # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be @@ -34,15 +33,19 @@ extensions = [ 'autoapi.extension', 'sphinx_rtd_theme', 'sphinx.ext.viewcode', + # 'recommonmark', + 'm2r2', ] +source_suffix = ['.rst', '.md'] + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # -- Options for HTML output ------------------------------------------------- @@ -57,7 +60,8 @@ html_theme = 'sphinx_rtd_theme' # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] + # -- Sphinx AudoAPI options -------------------------------------------------- autoapi_type = 'python' -autoapi_dirs = ['../../pycgtool'] +autoapi_dirs = ['../pycgtool'] diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/make.bat b/docs/make.bat index 6247f7e231716482115f34084ac61030743e0715..2119f51099bf37e4fdb6071dce9f451ea44c62dd 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,8 +7,8 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=source -set BUILDDIR=build +set SOURCEDIR=. +set BUILDDIR=_build if "%1" == "" goto help diff --git a/docs/source/mapping-only.rst b/docs/mapping-only.rst similarity index 100% rename from docs/source/mapping-only.rst rename to docs/mapping-only.rst diff --git a/docs/source/tutorial.rst b/docs/tutorial.rst similarity index 100% rename from docs/source/tutorial.rst rename to docs/tutorial.rst