-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
48 changed files
with
1,097 additions
and
660 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| name: Check Build | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| package: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Set up Python 3.12 | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.12" | ||
| cache: "pip" | ||
| cache-dependency-path: "**/pyproject.toml" | ||
| - name: Install build dependencies | ||
| run: python -m pip install --upgrade pip wheel twine build | ||
| - name: Build package | ||
| run: python -m build | ||
| - name: Check package | ||
| run: twine check --strict dist/*.whl |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| name: "Build docs using sphinx" | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request: | ||
| # also run on 'closed' to clean up the github pages dir | ||
| types: | ||
| - opened | ||
| - reopened | ||
| - synchronize | ||
| - closed | ||
|
|
||
| concurrency: preview-${{ github.ref }} | ||
|
|
||
| jobs: | ||
| docs: | ||
| name: "Build Docs" | ||
| runs-on: ubuntu-20.04 | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: "Set up Python" | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: 3.12 | ||
|
|
||
| - name: "Install hatch" | ||
| run: pip install hatch | ||
|
|
||
| - name: "Build docs with Sphinx" | ||
| run: hatch run docs:build -W --keep-going | ||
|
|
||
| - name: Deploy preview | ||
| if: github.event_name == 'pull_request' | ||
| uses: rossjrw/pr-preview-action@v1 | ||
| with: | ||
| source-dir: docs/_build/html | ||
|
|
||
| - name: Deploy docs | ||
| if: github.event_name != 'pull_request' | ||
| uses: JamesIves/github-pages-deploy-action@v4 | ||
| with: | ||
| folder: docs/_build/html | ||
| branch: gh-pages | ||
| clean-exclude: pr-preview/ | ||
| force: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ```{include} ../CHANGELOG.md | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Minimal makefile for Sphinx documentation | ||
| # | ||
|
|
||
| # You can set these variables from the command line, and also | ||
| # from the environment for the first two. | ||
| SPHINXOPTS ?= -W --keep-going | ||
| SPHINXBUILD ?= sphinx-build | ||
| SOURCEDIR = . | ||
| BUILDDIR = _build | ||
|
|
||
| # Put it first so that "make" without argument is like "make help". | ||
| help: | ||
| @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
|
||
| .PHONY: help Makefile | ||
|
|
||
| # Catch-all target: route all unknown targets to Sphinx using the new | ||
| # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
| %: Makefile | ||
| @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| /* Reduce the font size in data frames - See https://github.com/scverse/cookiecutter-scverse/issues/193 */ | ||
| div.cell_output table.dataframe { | ||
| font-size: 0.8em; | ||
| } |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| {{ fullname | escape | underline}} | ||
|
|
||
| .. currentmodule:: {{ module }} | ||
|
|
||
| .. add toctree option to make autodoc generate the pages | ||
| .. autoclass:: {{ objname }} | ||
|
|
||
| {% block attributes %} | ||
| {% if attributes %} | ||
| Attributes table | ||
| ~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. autosummary:: | ||
| {% for item in attributes %} | ||
| ~{{ name }}.{{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block methods %} | ||
| {% if methods %} | ||
| Methods table | ||
| ~~~~~~~~~~~~~ | ||
|
|
||
| .. autosummary:: | ||
| {% for item in methods %} | ||
| {%- if item != '__init__' %} | ||
| ~{{ name }}.{{ item }} | ||
| {%- endif -%} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block attributes_documentation %} | ||
| {% if attributes %} | ||
| Attributes | ||
| ~~~~~~~~~~ | ||
|
|
||
| {% for item in attributes %} | ||
|
|
||
| .. autoattribute:: {{ [objname, item] | join(".") }} | ||
| {%- endfor %} | ||
|
|
||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block methods_documentation %} | ||
| {% if methods %} | ||
| Methods | ||
| ~~~~~~~ | ||
|
|
||
| {% for item in methods %} | ||
| {%- if item != '__init__' %} | ||
|
|
||
| .. automethod:: {{ [objname, item] | join(".") }} | ||
| {%- endif -%} | ||
| {%- endfor %} | ||
|
|
||
| {% endif %} | ||
| {% endblock %} |
Oops, something went wrong.