From 8963d1c5a74dadad32275bab6a4c3450f48167eb Mon Sep 17 00:00:00 2001 From: Oceania2018 Date: Sun, 19 Aug 2018 16:36:06 -0500 Subject: [PATCH] relocate index.rst --- .gitignore | 1 + docs/Makefile | 4 ++-- docs/{source => }/conf.py | 13 ++++++------- docs/{source => }/index.rst | 2 +- docs/make.bat | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) rename docs/{source => }/conf.py (95%) rename docs/{source => }/index.rst (88%) diff --git a/.gitignore b/.gitignore index 90f9205a..8145526a 100644 --- a/.gitignore +++ b/.gitignore @@ -301,3 +301,4 @@ __pycache__/ /BotSharp.WebHost/PublishOutput /Data /docs/build +/docs/_build diff --git a/docs/Makefile b/docs/Makefile index 6df1251a..655d1b22 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,8 +5,8 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXPROJ = BotSharp -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 95% rename from docs/source/conf.py rename to docs/conf.py index 9d8757b5..ad9ea6c3 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- # # BotSharp documentation build configuration file, created by -# sphinx-quickstart on Sun Aug 19 10:12:30 2018. +# sphinx-quickstart on Sun Aug 19 10:40:29 2018. # # This file is execfile()d with the current directory set to its # containing dir. @@ -38,8 +38,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', - 'sphinx.ext.viewcode', - 'sphinx.ext.githubpages'] + 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -56,14 +55,14 @@ master_doc = 'index' # General information about the project. project = 'BotSharp' copyright = '2018, Haiping Chen' -author = 'Haiping Chen, Peng Bo' +author = 'Haiping Chen' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.1' +version = '0.1.0' # The full version, including alpha/beta/rc tags. release = '0.1.0' @@ -77,7 +76,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = [] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' @@ -148,7 +147,7 @@ latex_elements = { # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'BotSharp.tex', 'BotSharp Documentation', - 'Haiping Chen, Peng Bo', 'manual'), + 'Haiping Chen', 'manual'), ] diff --git a/docs/source/index.rst b/docs/index.rst similarity index 88% rename from docs/source/index.rst rename to docs/index.rst index 025020f7..cee9c207 100644 --- a/docs/source/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ .. BotSharp documentation master file, created by - sphinx-quickstart on Sun Aug 19 10:12:30 2018. + sphinx-quickstart on Sun Aug 19 10:40:29 2018. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/docs/make.bat b/docs/make.bat index 8117aa44..d63c593d 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 set SPHINXPROJ=BotSharp if "%1" == "" goto help