Skip to content

Commit

Permalink
Fix RtD links and Update documentation links and naming.
Browse files Browse the repository at this point in the history
Updated documentation links and clarified naming conventions in index.md and README.md. Changed the reference to the license from the generic term [license] to [Apache 2.0 license]. Additionally, the [command-line reference] has been renamed to [Command-line Usage], and [API Reference] was added for clarity. These changes improve the user's understanding of the content and ensure that the information is accurately linked.
  • Loading branch information
tasansal committed Sep 28, 2023
1 parent c614a87 commit 8917f46
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
[![Conda](https://img.shields.io/conda/vn/conda-forge/multidimio)][install_conda]
[![Python Version](https://img.shields.io/pypi/pyversions/multidimio)][python version]
[![Status](https://img.shields.io/pypi/status/multidimio.svg)][status]
[![License](https://img.shields.io/pypi/l/multidimio)][license]
[![License](https://img.shields.io/pypi/l/multidimio)][apache 2.0 license]

[![Tests](https://github.com/TGSAI/mdio-python/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/TGSAI/mdio-python/branch/main/graph/badge.svg)][codecov]
Expand Down Expand Up @@ -83,14 +83,14 @@ $ conda install -c conda-forge multidimio

> Extras must be installed separately on `Conda` environments.
For details, please see the [installation instructions][install]
For details, please see the [installation instructions]
in the documentation.

# Using MDIO

Please see the [Command-line Reference][usage] for details.
Please see the [Command-line Usage] for details.

For Python API please see the [API Reference][reference] for details.
For Python API please see the [API Reference] for details.

# Requirements

Expand All @@ -113,7 +113,7 @@ To learn more, see the [Contributor Guide].

# Licensing

Distributed under the terms of the [Apache 2.0 license][license],
Distributed under the terms of the [Apache 2.0 license],
_MDIO_ is free and open source software.

# Issues
Expand Down Expand Up @@ -151,8 +151,8 @@ template.

<!-- github-only -->

[license]: https://github.com/TGSAI/mdio-python/blob/main/LICENSE
[apache 2.0 license]: https://github.com/TGSAI/mdio-python/blob/main/LICENSE
[contributor guide]: https://github.com/TGSAI/mdio-python/blob/main/CONTRIBUTING.md
[usage]: https://mdio-python.readthedocs.io/en/latest/usage.html
[reference]: https://mdio-python.readthedocs.io/en/latest/reference.html
[install]: https://mdio-python.readthedocs.io/en/latest/installation.html
[command-line usage]: https://mdio-python.readthedocs.io/en/latest/usage.html
[api reference]: https://mdio-python.readthedocs.io/en/latest/reference.html
[installation instructions]: https://mdio-python.readthedocs.io/en/latest/installation.html
6 changes: 4 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ end-before: <!-- github-only -->
---
```

[license]: license
[apache 2.0 license]: license
[contributor guide]: contributing
[command-line reference]: usage
[command-line usage]: usage
[api reference]: reference
[installation instructions]: installation

```{toctree}
---
Expand Down

0 comments on commit 8917f46

Please sign in to comment.