Skip to content

Commit 0eb09d1

Browse files
committed
Add Read the Docs build configuration
1 parent a6bfd8a commit 0eb09d1

2 files changed

Lines changed: 31 additions & 17 deletions

File tree

.readthedocs.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.11"
7+
8+
mkdocs:
9+
configuration: mkdocs.yml
10+
11+
python:
12+
install:
13+
- requirements: requirements.txt

mkdocs.yml

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
site_name: phy
2-
pages:
3-
- Getting started:
4-
- Introduction: 'index.md'
5-
- Release notes: 'release.md'
6-
- Troubleshooting: 'troubleshooting.md'
7-
- User guide:
8-
- Terminology: 'terminology.md'
9-
- Interactive visualization: 'visualization.md'
10-
- Manual clustering: 'clustering.md'
11-
- Keyboard shortcuts and snippets: 'shortcuts.md'
12-
- Tutorials:
13-
- Manual Clustering Practical Guide (by S. Lenzi and N. Steinmetz): 'sorting_user_guide.md'
14-
- Developer guide:
15-
- Customization: 'customization.md'
16-
- Plugin examples: 'plugins.md'
17-
- Data analysis: 'analysis.md'
18-
- API documentation: 'api.md'
2+
nav:
3+
- Getting started:
4+
- Introduction: index.md
5+
- Release notes: release.md
6+
- Troubleshooting: troubleshooting.md
7+
- User guide:
8+
- Terminology: terminology.md
9+
- Interactive visualization: visualization.md
10+
- Manual clustering: clustering.md
11+
- Keyboard shortcuts and snippets: shortcuts.md
12+
- Tutorials:
13+
- Manual Clustering Practical Guide (by S. Lenzi and N. Steinmetz): sorting_user_guide.md
14+
- Developer guide:
15+
- Customization: customization.md
16+
- Plugin examples: plugins.md
17+
- Data analysis: analysis.md
18+
- API documentation: api.md
1919
theme: readthedocs
20+
docs_dir: docs

0 commit comments

Comments
 (0)