#42 Create initial blank pages for dev docs

PainterQubits · Apr 29, 2024 · e012d5d · e012d5d
1 parent 8807f0a
commit e012d5d
Show file tree

Hide file tree

Showing 24 changed files with 344 additions and 39 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1 @@
+# Contributing
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # ParamDB
 
-<!-- start badges -->
+<!-- start intro -->
 
 [![PyPI Latest Release](https://img.shields.io/pypi/v/paramdb)](https://pypi.org/project/paramdb/)
 [![PyPI Python Versions](https://img.shields.io/pypi/pyversions/paramdb)](https://pypi.org/project/paramdb/)
@@ -9,10 +9,6 @@
 [![Codecov](https://codecov.io/github/PainterQubits/paramdb/branch/main/graph/badge.svg?token=PQEJWLBTBK)](https://codecov.io/github/PainterQubits/paramdb)
 [![Documentation Status](https://readthedocs.org/projects/paramdb/badge/?version=stable)](https://paramdb.readthedocs.io/en/stable/?badge=stable)
 
-<!-- end badges -->
-
-<!-- start intro -->
-
 Python package for storing and retrieving experiment parameters.
 
 <!-- end intro -->

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,10 @@
+.PHONY: dev, build, clean
+
+clean:
+	@rm -rf build
+
+dev: clean
+	@poetry run sphinx-autobuild source build
+
+build: clean
+	@poetry run sphinx-build source build
diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/license.md b/docs/license.md
diff --git a/docs/_static/jupyter-sphinx.css → docs/source/_static/jupyter-sphinx.css b/docs/_static/jupyter-sphinx.css → docs/source/_static/jupyter-sphinx.css
diff --git a/docs/api-reference.md → docs/source/api-reference.md b/docs/api-reference.md → docs/source/api-reference.md
diff --git a/docs/source/changelog.md b/docs/source/changelog.md
@@ -0,0 +1,3 @@
+```{include} ../../CHANGELOG.md
+
+```
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -18,6 +18,11 @@
 # HTML output options
 html_theme = "furo"
 html_static_path = ["_static"]
+html_theme_options = {
+    "source_repository": "https://github.com/PainterQubits/paramdb",
+    "source_branch": "develop",
+    "source_directory": "docs",
+}
 
 # MyST options
 myst_heading_anchors = 3

diff --git a/docs/database.md → docs/source/database.md b/docs/database.md → docs/source/database.md
diff --git a/docs/source/development/code-of-conduct.md b/docs/source/development/code-of-conduct.md
@@ -0,0 +1,3 @@
+```{include} ../../../CODE_OF_CONDUCT.md
+
+```
diff --git a/docs/source/development/contributing.md b/docs/source/development/contributing.md
@@ -0,0 +1,3 @@
+```{include} ../../../CONTRIBUTING.md
+
+```
diff --git a/docs/source/development/dependency-management.md b/docs/source/development/dependency-management.md
@@ -0,0 +1 @@
+# Dependency Managment
diff --git a/docs/source/development/documentation-website.md b/docs/source/development/documentation-website.md
@@ -0,0 +1,3 @@
+# Documentation Website
+
+Written, using sphinx
diff --git a/docs/source/development/environment-setup.md b/docs/source/development/environment-setup.md
@@ -0,0 +1,3 @@
+# Environment Setup
+
+Install Python, Poetry, etc.
diff --git a/docs/source/development/project-design.md b/docs/source/development/project-design.md
@@ -0,0 +1 @@
+# Project Design
diff --git a/docs/source/development/project-structure.md b/docs/source/development/project-structure.md
@@ -0,0 +1 @@
+# Project Structure
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -0,0 +1,30 @@
+# ParamDB
+
+```{include} ../../README.md
+:start-after: <!-- start intro -->
+:end-before: <!-- end intro -->
+```
+
+```{toctree}
+:hidden:
+
+installation
+parameter-data
+database
+api-reference
+changelog
+license
+```
+
+```{toctree}
+:caption: Development
+:hidden:
+
+development/environment-setup
+development/dependency-management
+development/project-structure
+development/project-design
+development/documentation-website
+development/contributing
+Code of Conduct<development/code-of-conduct>
+```
diff --git a/docs/installation.md → docs/source/installation.md b/docs/installation.md → docs/source/installation.md
@@ -1,6 +1,6 @@
 # Installation
 
-```{include} ../README.md
+```{include} ../../README.md
 :start-after: <!-- start installation -->
 :end-before: <!-- end installation -->
 ```
diff --git a/docs/source/license.md b/docs/source/license.md
@@ -0,0 +1,5 @@
+# License
+
+```{include} ../../LICENSE
+
+```
diff --git a/docs/parameter-data.md → docs/source/parameter-data.md b/docs/parameter-data.md → docs/source/parameter-data.md
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,6 +40,7 @@ furo = "^2024.1.29"
 sphinx-copybutton = "^0.5.2"
 jupyter-sphinx = "^0.5.3"
 ipykernel = "^6.29.4"
+sphinx-autobuild = "^2024.4.16"
 
 [tool.mypy]
 strict = true
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Environment Setup

		Install Python, Poetry, etc.