Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"undoc-members": False,
}

root_doc = "docs/index"
root_doc = "index"
templates_path = ["_templates"]
exclude_patterns = [
".git",
Expand All @@ -45,6 +45,7 @@
"dist",
"docs/_build",
"docs/_build/**",
"docs/index.md",
"CHANGELOG.rst",
"README.md",
"SUPPORT.rst",
Expand Down
25 changes: 25 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Documentation site for `jitr`

`jitr` is a calculable R-matrix toolkit for nuclear-reaction modeling,
uncertainty propagation, and optical-potential workflows.

## Documentation

If you are new to the project, start with
[Getting started](docs/getting-started.md), then browse the curated
[example notebooks](docs/examples/index.md), and use the
[API reference](docs/api/index.md) when you want implementation details.


## Site Contents
```{toctree}
:maxdepth: 2
:titlesonly:
:caption: Documentation

docs/getting-started
docs/tests
docs/advanced-users
docs/api/index
docs/examples/index
```