docs: change to sphinx build/source structure

jolars · Nov 29, 2023 · ed9ab31 · ed9ab31
1 parent b4a5bac
commit ed9ab31
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 17 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,12 +1,12 @@
-#
 # Minimal makefile for Sphinx documentation
+#
 
 # You can set these variables from the command line, and also
 # 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:

diff --git 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=.
-set BUILDDIR=_build
+set SOURCEDIR=source
+set BUILDDIR=build
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (

diff --git a/docs/slope.rst b/docs/slope.rst
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -0,0 +1,10 @@
+################
+ Main Functions
+################
+
+.. currentmodule:: sortedl1
+
+.. autosummary::
+   :toctree: generated/
+
+   slope
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -1,20 +1,23 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("../.."))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "sortedl1"
 copyright = "2023, Johan Larsson"
 author = "Johan Larsson"
+release = "0.1.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.doctest",
     "sphinx.ext.napoleon",
 ]
 templates_path = ["_templates"]
@@ -24,7 +27,6 @@
     ".DS_Store",
 ]
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

diff --git a/docs/source/generated/sortedl1.slope.rst b/docs/source/generated/sortedl1.slope.rst
@@ -0,0 +1,6 @@
+sortedl1.slope
+==============
+
+.. currentmodule:: sortedl1
+
+.. autofunction:: slope
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
@@ -1,6 +1,6 @@
 ..
    sortedl1 documentation master file, created by
-   sphinx-quickstart on Tue Nov 28 15:58:40 2023.
+   sphinx-quickstart on Tue Nov 28 20:48:55 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
@@ -12,6 +12,8 @@
    :maxdepth: 2
    :caption: Contents:
 
+   api
+
 ####################
  Indices and tables
 ####################

diff --git a/docs/modules.rst → docs/source/modules.rst b/docs/modules.rst → docs/source/modules.rst
diff --git a/docs/sortedl1.rst → docs/source/sortedl1.rst b/docs/sortedl1.rst → docs/source/sortedl1.rst
@@ -4,10 +4,10 @@ sortedl1 package
 Submodules
 ----------
 
-sortedl1.slope module
----------------------
+sortedl1.models module
+----------------------
 
-.. automodule:: sortedl1.slope
+.. automodule:: sortedl1.models
    :members:
    :undoc-members:
    :show-inheritance: