Skip to content

Commit 33808e6

Browse files
committed
docs and pixi for pyprojects
1 parent 73df0d5 commit 33808e6

File tree

4 files changed

+40
-0
lines changed

4 files changed

+40
-0
lines changed

pyproject/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# {{ cookiecutter.project_name }}
2+
3+
Source code for the {{ cookiecutter.project_name }} project.
4+
Use `pip` or `pixi` to install the package in editable mode.

pyproject/docs/conf.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
from importlib.metadata import version as importlibversion
2+
3+
project = "{{ cookiecutter.project_name }}"
4+
author = "WardDeb"
5+
version = importlibversion("{{ cookiecutter.project_slug }}")
6+
release = version
7+
8+
extensions = [
9+
'sphinx_click.ext'
10+
]
11+
language = "en"
12+
master_doc = 'index'
13+
pygments_style = 'sphinx'
14+
source_suffix = '.rst'
15+
html_theme = 'sphinx_rtd_theme'

pyproject/docs/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{{ cookiecutter.project_name }}
2+
===============================
3+
4+
Documentation for the {{ cookiecutter.project_name }} project.
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
:caption: Contents:

pyproject/{{ cookiecutter.project_slug }}/pyproject.toml renamed to pyproject/pyproject.toml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,21 @@ dependencies = [
1919
dev = [
2020
"ruff",
2121
"pytest",
22+
"sphinx",
23+
"sphinx-rtd-theme",
24+
"sphinx-click"
2225
]
2326

2427
[project.scripts]
2528

2629
[tool.setuptools_scm]
30+
[tool.ruff]
31+
exclude = [
32+
"docs",
33+
"tests"
34+
]
35+
[tool.pixi.workspace]
36+
channels = ['conda-forge', 'bioconda']
37+
platforms = ['linux-64', 'osx-arm64', 'osx-64']
38+
[tool.pixi.pypi-dependencies]
39+
{{ cookiecutter.project_slug }} = {path = ".", editable = true, extras = ['dev']}

0 commit comments

Comments
 (0)