Skip to content

Commit cac1411

Browse files
committed
convert docs from rst to myst
1 parent e3466f6 commit cac1411

12 files changed

+57
-65
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# bmi-tester
2+
13
[anaconda-badge]: https://anaconda.org/conda-forge/bmi-tester/badges/version.svg
24
[anaconda-link]: https://anaconda.org/conda-forge/bmi-tester
35
[build-badge]: https://github.com/csdms/bmi-tester/actions/workflows/test.yml/badge.svg
@@ -10,8 +12,6 @@
1012
[pypi-link]: https://pypi.org/project/bmi-tester/
1113
[python-badge]: https://img.shields.io/pypi/pyversions/bmi-tester.svg
1214

13-
# bmi-tester: Test Basic Model Interface implementations
14-
1515
![[Build Status][build-link]][build-badge]
1616
![[PyPI][pypi-link]][pypi-badge]
1717
![[Anaconda][anaconda-link]][anaconda-badge]

docs/authors.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../AUTHORS.md
2+
```

docs/authors.rst

-1
This file was deleted.

docs/changelog.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../CHANGES.md
2+
```

docs/changelog.rst

-1
This file was deleted.

docs/conf.py

+3
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,15 @@
3030
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3131
# ones.
3232
extensions = [
33+
"myst_parser",
3334
"sphinx.ext.autodoc",
3435
"sphinx.ext.viewcode",
3536
"sphinx.ext.todo",
3637
"sphinx.ext.mathjax",
3738
"sphinx.ext.napoleon",
3839
"sphinx.ext.autosummary",
40+
"sphinx_copybutton",
41+
"sphinx_inline_tabs",
3942
]
4043

4144
# Add any paths that contain templates here, relative to this directory.

docs/index.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
```{image} _static/bmi-tester-logo-text-lowercase.png
2+
:align: center
3+
:alt: Sequence
4+
:scale: 10%
5+
:target: https://sequence.readthedocs.org/
6+
```
7+
8+
The `bmi_tester` package provides command-line utilities for testing
9+
a Python classes that implement the Basic Model Interface (BMI).
10+
`bmi_tester` also provides a Python interface to the tester that allows
11+
users to run tests programmatically. The package is also easily
12+
extendable so that new tests can be added to the suite.
13+
14+
```{include} ../README.md
15+
```
16+
17+
# API Reference
18+
19+
If you are looking for information on a specific function, class, or
20+
method, this part of the documentation is for you.
21+
22+
```{toctree}
23+
:maxdepth: 2
24+
25+
api/index
26+
```
27+
28+
# Miscellaneous Pages
29+
30+
```{toctree}
31+
:maxdepth: 2
32+
33+
authors
34+
changelog
35+
license
36+
```
37+
38+
## Indices and tables
39+
40+
- {ref}`genindex`
41+
- {ref}`modindex`
42+
- {ref}`search`

docs/index.rst

-54
This file was deleted.

docs/license.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../LICENSE.md
2+
```

docs/license.rst

-5
This file was deleted.

docs/readme.rst

-1
This file was deleted.

requirements-docs.txt

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
sphinx>=1.5.1
1+
sphinx
2+
myst-parser
3+
sphinx-inline-tabs
4+
sphinx_copybutton

0 commit comments

Comments
 (0)