Merge pull request #55 from UiO-IN3110/dokken/sphinx-docs

Update sphinx docs

Author: minrk

lectures/production/sphinx-docs.ipynb

@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

…roduction/sphinx-docs/docs-done/Makefile …roduction/sphinx-docs/docs-2023/Makefilelectures/production/sphinx-docs/docs-done/Makefile renamed to lectures/production/sphinx-docs/docs-2023/Makefile lectures/production/sphinx-docs/docs-done/Makefile renamed to lectures/production/sphinx-docs/docs-2023/Makefile

@@ -1,35 +1,35 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-%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.https://www.sphinx-doc.org/
-	exit /b 1
-)
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

…res/production/sphinx-docs/docs/make.bat …roduction/sphinx-docs/docs-2023/make.batlectures/production/sphinx-docs/docs/make.bat renamed to lectures/production/sphinx-docs/docs-2023/make.bat lectures/production/sphinx-docs/docs/make.bat renamed to lectures/production/sphinx-docs/docs-2023/make.bat

@@ -0,0 +1,30 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "MyArray"
+copyright = "2023, Jørgen S. Dokken"
+author = "Jørgen S. Dokken"
+release = "1.0.0"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "alabaster"
+html_static_path = ["_static"]

…production/sphinx-docs/docs-done/api.rst …ion/sphinx-docs/docs-2023/source/api.rstlectures/production/sphinx-docs/docs-done/api.rst renamed to lectures/production/sphinx-docs/docs-2023/source/api.rst lectures/production/sphinx-docs/docs-done/api.rst renamed to lectures/production/sphinx-docs/docs-2023/source/api.rst

@@ -1,19 +1,18 @@
-.. My Array documentation master file, created by
-   sphinx-quickstart on Mon Nov 16 11:58:36 2020.
+.. MyArray documentation master file, created by
+   sphinx-quickstart on Tue Nov 14 12:57:04 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to My Array's documentation!
-====================================
+Welcome to MyArray's documentation!
+===================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
-
+   
    api.rst
 
 
-
 Indices and tables
 ==================