Get pixi run docs working

mdaeron · Oct 16, 2024 · d8df23e · d8df23e
1 parent e0cdee0
commit d8df23e
Show file tree

Hide file tree

Showing 24 changed files with 865 additions and 159 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+# GitHub syntax highlighting
+pixi.lock linguist-language=YAML linguist-generated=true
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Mathieu Daëron
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/code_examples/virtual_data/output.txt b/code_examples/virtual_data/output.txt
diff --git a/docs/cli.md → docpages/cli.md b/docs/cli.md → docpages/cli.md
diff --git a/docs/discussion.md → docpages/discussion.md b/docs/discussion.md → docpages/discussion.md
diff --git a/docs/howto.md → docpages/howto.md b/docs/howto.md → docpages/howto.md
diff --git a/docs/old_documentation.md → docpages/old_documentation.md b/docs/old_documentation.md → docpages/old_documentation.md
diff --git a/docs/tutorial.md → docpages/tutorial.md b/docs/tutorial.md → docpages/tutorial.md
diff --git a/docs/D47_plot_Session_01.png b/docs/D47_plot_Session_01.png
diff --git a/docs/D47_plot_Session_02.png b/docs/D47_plot_Session_02.png
diff --git a/docs/D47_plot_Session_03.png b/docs/D47_plot_Session_03.png
diff --git a/docs/D47_plot_Session_04.png b/docs/D47_plot_Session_04.png
diff --git a/docs/D47_plot_Session_05.png b/docs/D47_plot_Session_05.png
diff --git a/docs/D47_plot_Session_06.png b/docs/D47_plot_Session_06.png
diff --git a/docs/D47_plot_Session_07.png b/docs/D47_plot_Session_07.png
diff --git a/docs/D47_plot_Session_08.png b/docs/D47_plot_Session_08.png
diff --git a/docs/D47_plot_Session_09.png b/docs/D47_plot_Session_09.png
diff --git a/docs/D47_plot_Session_10.png b/docs/D47_plot_Session_10.png
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/residuals.png b/docs/residuals.png
diff --git a/docs/time_distribution.png b/docs/time_distribution.png
diff --git a/license.md b/license.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,19 +1,11 @@
-[build-system]
-requires = ["flit_core >=3.2,<4"]
-build-backend = "flit_core.buildapi"
-
 [project]
 name = "D47crunch"
 authors = [{name = "Mathieu Daëron", email = "[email protected]"}]
-readme = "readme.md"
 dynamic = ["version", "description"]
-license = {text = "BSD-3-Clause"}
-classifiers = [
-	"Programming Language :: Python :: 3",
-	"License :: OSI Approved :: BSD License",
-	"Operating System :: OS Independent",
-]
-requires-python = ">=3.8"
+readme = "readme.md"
+license = {file = "LICENSE"}
+classifiers = ["License :: OSI Approved :: MIT License"]
+requires-python = ">= 3.8"
 dependencies = [
     "numpy >=1.21",
     "scipy >=1.7.0",
@@ -23,6 +15,26 @@ dependencies = [
     "rich",
 ]
 
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.pixi.project]
+channels = ["conda-forge"]
+platforms = ["osx-arm64"]
+
+[tool.pixi.pypi-dependencies]
+D47crunch = { path = ".", editable = true }
+
+[tool.pixi.system-requirements]
+macos = "12.7.5"
+
+[tool.pixi.dependencies]
+pdoc = ">=14.4.0,<15"
+
+[tool.pixi.tasks]
+docs = {cmd = 'python build_doc.py'}
+
 [project.urls]
 Home = "https://github.com/mdaeron/D47crunch"
 Documentation = "https://mdaeron.github.io/D47crunch"

diff --git a/D47crunch/__init__.py → src/D47crunch/__init__.py b/D47crunch/__init__.py → src/D47crunch/__init__.py
@@ -9,9 +9,9 @@
 The **tutorial** section takes you through a series of simple steps to import/process data and print out the results.
 The **how-to** section provides instructions applicable to various specific tasks.
 
-.. include:: ../docs/tutorial.md
-.. include:: ../docs/howto.md
-.. include:: ../docs/cli.md
+.. include:: ../../docpages/tutorial.md
+.. include:: ../../docpages/howto.md
+.. include:: ../../docpages/cli.md
 
 # 4. API Documentation
 '''
@@ -472,13 +472,13 @@ def virtual_data(
 	anchors and unknowns for a bunch of sessions:
 
 	```py
-	.. include:: ../code_examples/virtual_data/example.py
+	.. include:: ../../code_examples/virtual_data/example.py
 	```
 	
 	This should output something like:
 	
 	```
-	.. include:: ../code_examples/virtual_data/output.txt
+	.. include:: ../../code_examples/virtual_data/output.txt
 	```
 	'''
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# GitHub syntax highlighting
		pixi.lock linguist-language=YAML linguist-generated=true