Restructuration of documentation

funilrys · Jun 13, 2018 · 4ea01a0 · 4ea01a0
1 parent 88c8e45
commit 4ea01a0
Show file tree

Hide file tree

Showing 15 changed files with 43 additions and 11 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = PyFunceble
-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/code-of-conduct.rst → docs/code-of-conduct.rst b/docs/source/code-of-conduct.rst → docs/code-of-conduct.rst
diff --git a/docs/source/code.rst → docs/code.rst b/docs/source/code.rst → docs/code.rst
diff --git a/docs/source/colomns.rst → docs/colomns.rst b/docs/source/colomns.rst → docs/colomns.rst
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
@@ -29,14 +29,13 @@ def _get_version(full=False):
     """
 
     to_match = comp(r'VERSION\s=\s"(.*)"\n')
-    extracted = to_match.findall(open("../../PyFunceble/__init__.py").read())[0]
+    extracted = to_match.findall(open("../PyFunceble/__init__.py").read())[0]
 
     if not full:
         return ".".join(list(filter(lambda x: x.isdigit(), extracted.split("."))))
     else:
         return extracted
 
-
 # -- Project information -----------------------------------------------------
 
 project = 'PyFunceble'
@@ -65,7 +64,6 @@ def _get_version(full=False):
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -90,7 +88,7 @@ def _get_version(full=False):
 # 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']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -101,7 +99,7 @@ def _get_version(full=False):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -208,4 +206,4 @@ def _get_version(full=False):
 # -- Options for todo extension ----------------------------------------------
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
+todo_include_todos = True
diff --git a/docs/source/contact.rst → docs/contact.rst b/docs/source/contact.rst → docs/contact.rst
diff --git a/docs/source/contributing.rst → docs/contributing.rst b/docs/source/contributing.rst → docs/contributing.rst
diff --git a/docs/source/contributors.rst → docs/contributors.rst b/docs/source/contributors.rst → docs/contributors.rst
diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
@@ -29,11 +29,9 @@ Main Features
 -   Save results on file(s)
 -   ... and a lot more!
 
-Contents
-=================
-
 .. toctree::
    :maxdepth: 2
+   :caption: Contents
 
    installation
    colomns

diff --git a/docs/source/installation.rst → docs/installation.rst b/docs/source/installation.rst → docs/installation.rst
diff --git a/docs/source/license.rst → docs/license.rst b/docs/source/license.rst → docs/license.rst
diff --git a/docs/source/logic-representation.rst → docs/logic-representation.rst b/docs/source/logic-representation.rst → docs/logic-representation.rst
diff --git a/docs/source/logs-sharing.rst → docs/logs-sharing.rst b/docs/source/logs-sharing.rst → docs/logs-sharing.rst
diff --git a/docs/make.bat b/docs/make.bat
@@ -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=PyFunceble
+
+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
diff --git a/docs/source/special-thanks.rst → docs/special-thanks.rst b/docs/source/special-thanks.rst → docs/special-thanks.rst