Skip to content

Commit fdeb167

Browse files
committed
docs: some sections + edit button etc
1 parent c024b25 commit fdeb167

File tree

3 files changed

+15
-12
lines changed

3 files changed

+15
-12
lines changed

docs/Makefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ help:
1414

1515
.PHONY: help Makefile
1616

17+
clean:
18+
rm -rf build
19+
rm -rf source/generated
20+
rm -rf source/gallery
21+
rm -rf source/autoapi
22+
rm -rf source/sg_execution_times.rst
23+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) clean
24+
1725
# Catch-all target: route all unknown targets to Sphinx using the new
1826
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1927
%: Makefile

docs/source/api.rst

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,6 @@ Top-level API
1313
from_dataframe
1414
trajectory_dict_to_dataset (deprecated)
1515

16-
.. Geometries
17-
.. ----------
18-
.. .. autosummary::
19-
.. :toctree: generated/
20-
21-
.. geometry.decode_geometries
22-
.. geometry.encode_geometries
23-
.. geometry.shapely_to_cf
24-
.. geometry.cf_to_shapely
25-
.. geometry.GeometryNames
26-
2716
.. currentmodule:: xarray
2817

2918
.. DataArray

docs/source/conf.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
import os, sys
22
sys.path.insert(0, os.path.abspath('../..'))
33

4+
import trajan # noqa
5+
46
import sphinx_autosummary_accessors
57
# Configuration file for the Sphinx documentation builder.
68

79
# -- Project information
810

911
project = 'TrajAn'
10-
copyright = '2022-2023, G. Hope and K. F. Dagestad'
12+
copyright = '2022-2024, G. Hope and K. F. Dagestad'
1113
author = 'G. Hope and K. F. Dagestad'
1214

1315
release = 'latest (git / main)'
@@ -70,6 +72,10 @@
7072
"doc_path": "docs",
7173
}
7274

75+
html_theme_options = {
76+
"use_edit_page_button": True,
77+
}
78+
7379
autosummary_generate = True
7480

7581
autodoc_typehints = "description"

0 commit comments

Comments
 (0)