Added src folder in sphinx docs config

README.md

@@ -45,8 +45,9 @@ Take a look at the [Java API](https://github.com/sirfoga/jhal) for the Java equi
 
 
 ## Usage and documentation
-- You can browse the [html](docs/doxygen/html/index.html) (or if you prefer the [epydoc docs](docs/epydoc/html/index.html))
-- There is also the [pdf](docs/doxygen/pdf/api.pdf) version (for the epydoc pdfs go [here](docs/epydoc/pdf)
+- you can browse the [html](docs/doxygen/html/index.html) (or if you prefer the [epydoc docs](docs/epydoc/html/index.html))
+- there is also the [pdf](docs/doxygen/pdf/api.pdf) version (for the epydoc pdfs go [here](docs/epydoc/pdf)
+- download the repository and open the [sphinx](docs/sphinx/_build/html/index.html) documentation
 
 
 ## Questions and issues

docs/sphinx/conf.py

@@ -16,11 +16,16 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
 
+import os
+import sys
+
+cwd = os.getcwd()  # current working folder
+docs_folder = os.path.dirname(cwd)
+project_root = os.path.dirname(docs_folder)
+project_root = os.path.join(project_root, "hal")
+
+sys.path.insert(0, project_root)  # add root
 
 # -- General configuration ------------------------------------------------
 
@@ -32,10 +37,10 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
-    'sphinx.ext.coverage',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages']
+              'sphinx.ext.doctest',
+              'sphinx.ext.coverage',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.githubpages']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -59,7 +64,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '4.6.1'
+version = '4.6'
 # The full version, including alpha/beta/rc tags.
 release = '4.6.1'
 
@@ -81,7 +86,6 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
-
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -115,13 +119,11 @@
     ]
 }
 
-
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'PyHaldoc'
 
-
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
@@ -150,7 +152,6 @@
      'Stefano Fogarollo', 'manual'),
 ]
 
-
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
@@ -160,7 +161,6 @@
      [author], 1)
 ]
 
-
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
@@ -171,6 +171,3 @@
      author, 'PyHal', 'One line description of project.',
      'Miscellaneous'),
 ]
-
-
-