Skip to content

Commit

Permalink
rename usage to Python API
Browse files Browse the repository at this point in the history
  • Loading branch information
piskunow committed Nov 25, 2023
1 parent 887e5f9 commit 0f529a1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ You can install _KPM Tools_ via [pip] from [PyPI]:
$ pip install kpm-tools
```

## Usage
## Python API

Please see the [Command-line Reference] for details.
Please see the [Python API reference] for details.

## Contributing

Expand Down Expand Up @@ -83,4 +83,4 @@ This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter]

[license]: https://github.com/piskunow/kpm-tools/blob/main/LICENSE
[contributor guide]: https://github.com/piskunow/kpm-tools/blob/main/CONTRIBUTING.md
[command-line reference]: https://kpm-tools.readthedocs.io/en/latest/usage.html
[Python API reference]: https://kpm-tools.readthedocs.io/en/latest/api.html
4 changes: 2 additions & 2 deletions docs/usage.md → docs/api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Usage
# Python API

```{eval-rst}
.. click:: kpm_tools.__main__:main
Expand All @@ -11,7 +11,7 @@ Each of the following sections describes the usage of different modules in the `
## Bloch Module

```{eval-rst}
.. automodule:: kpm_tools
.. automodule:: kpm_tools.bloch
:members:
:undoc-members:
:show-inheritance:
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ end-before: <!-- github-only -->

[license]: license
[contributor guide]: contributing
[command-line reference]: usage
[Python API]: api

```{toctree}
---
Expand All @@ -15,8 +15,8 @@ maxdepth: 1
---
Tutorials <tutorials>
usage
reference
api
<!-- reference -->
contributing
Code of Conduct <codeofconduct>
License <license>
Expand Down

0 comments on commit 0f529a1

Please sign in to comment.