docs: clean up documentation and add copybutton

jolars · Dec 11, 2023 · 4e51a29 · 4e51a29
1 parent 6071f9d
commit 4e51a29
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 31 deletions.
diff --git a/Makefile b/Makefile
@@ -20,12 +20,13 @@ docs:
 	sphinx-apidoc -o docs/source sortedl1 ;\
 	cd docs ;\
 	make html
+
+.PHONY: autodoc
+autodoc:
+	sphinx-autobuild docs/source docs/build
 
 .PHONY: update-libslope
 update-libslope:
 	@mkdir -p tmp
 	@curl -L $(LIBSLOPE_RELEASE) | tar -xz --strip-components=1 -C tmp
-	@rm -rf src/slope
-	@cp -ri tmp/src/slope src/
-	@rm -rf tmp
-
+	@rm -rf src/slope @cp -ri tmp/src/slope src/ @rm -rf tmp
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,6 +1,6 @@
-################
- Main Functions
-################
+###############
+ API Reference
+###############
 
 .. currentmodule:: sortedl1
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,6 +21,7 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.doctest",
     "sphinx.ext.napoleon",
+    "sphinx_copybutton",
 ]
 templates_path = ["_templates"]
 exclude_patterns = [

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
diff --git a/docs/source/sortedl1.rst b/docs/source/sortedl1.rst
@@ -1,27 +1,23 @@
-sortedl1 package
-================
+##################
+ sortedl1 package
+##################
 
-Submodules
-----------
+************
+ Submodules
+************
 
-sortedl1.estimators module
---------------------------
+****************************
+ sortedl1.estimators module
+****************************
 
 .. automodule:: sortedl1.estimators
    :members:
    :undoc-members:
    :show-inheritance:
 
-sortedl1.version module
------------------------
-
-.. automodule:: sortedl1.version
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
+*****************
+ Module contents
+*****************
 
 .. automodule:: sortedl1
    :members:

diff --git a/pyproject.toml b/pyproject.toml
@@ -30,7 +30,7 @@ Homepage = "https://jolars.github.io/sortedl1/"
 Source = "https://github.com/jolars/sortedl1"
 
 [project.optional-dependencies]
-docs = ["sphinx", "furo"]
+docs = ["sphinx", "furo", "sphinx-copybutton"]
 
 [tool.scikit-build]
 build-dir = "build/{wheel_tag}"