align doc folder structure with hyperspy

.gitignore

@@ -4,5 +4,5 @@
 dist/*
 build/*
 .vscode/*
-doc/build
-doc/source/api
+doc/_build
+doc/api

doc/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:

doc/source/changelog.rst → doc/changelog.rst

@@ -1,3 +1,3 @@
 .. This is a stub, see the top level CHANGELOG.rst file for the changelog.
 
-.. include:: ../../CHANGELOG.rst
+.. include:: ../CHANGELOG.rst

doc/source/conf.py → doc/conf.py

@@ -4,7 +4,7 @@
 # add these directories to sys.path here.
 import sys
 
-sys.path.append("../../")
+sys.path.append("../")
 
 
 # -- Project information
@@ -61,17 +61,17 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["../_static"]
+html_static_path = ["_static"]
 html_css_files = ["css/custom.css"]
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = "../_static/logo_rec_april21.svg"
+html_logo = "_static/logo_rec_april21.svg"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-html_favicon = "../_static/lumispy.ico"
+html_favicon = "_static/lumispy.ico"
 
 # -- Options for EPUB output
 epub_show_urls = "footnote"
@@ -90,11 +90,11 @@ def run_apidoc(_):
 
     cur_dir = os.path.normpath(os.path.dirname(__file__))
     output_path = os.path.join(cur_dir, "api")
-    modules = os.path.normpath(os.path.join(cur_dir, "../../lumispy"))
+    modules = os.path.normpath(os.path.join(cur_dir, "../lumispy"))
     exclude_pattern = [
-        "../../lumispy/tests",
-        "../../lumispy/components",
-        "../../lumispy/release_info.py",
+        "../lumispy/tests",
+        "../lumispy/components",
+        "../lumispy/release_info.py",
     ]
     main(["-e", "-f", "-P", "-o", output_path, modules, *exclude_pattern])
 

doc/source/contributing.rst → doc/contributing.rst

@@ -1,3 +1,3 @@
 .. This is a stub, see the top level CONTRIBUTING.rst file for the changelog.
 
-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../CONTRIBUTING.rst

doc/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