Skip to content

Commit ee7a225

Browse files
authored
Merge pull request #286 from TGSAI/docs/fix_rtd_links
Fix RtD index page links and update documentation links and naming.
2 parents c614a87 + 13235b4 commit ee7a225

File tree

3 files changed

+17
-15
lines changed

3 files changed

+17
-15
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
[![Conda](https://img.shields.io/conda/vn/conda-forge/multidimio)][install_conda]
1414
[![Python Version](https://img.shields.io/pypi/pyversions/multidimio)][python version]
1515
[![Status](https://img.shields.io/pypi/status/multidimio.svg)][status]
16-
[![License](https://img.shields.io/pypi/l/multidimio)][license]
16+
[![License](https://img.shields.io/pypi/l/multidimio)][apache 2.0 license]
1717

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

8484
> Extras must be installed separately on `Conda` environments.
8585
86-
For details, please see the [installation instructions][install]
86+
For details, please see the [installation instructions]
8787
in the documentation.
8888

8989
# Using MDIO
9090

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

93-
For Python API please see the [API Reference][reference] for details.
93+
For Python API please see the [API Reference] for details.
9494

9595
# Requirements
9696

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

114114
# Licensing
115115

116-
Distributed under the terms of the [Apache 2.0 license][license],
116+
Distributed under the terms of the [Apache 2.0 license],
117117
_MDIO_ is free and open source software.
118118

119119
# Issues
@@ -123,10 +123,9 @@ please [file an issue] along with a detailed description.
123123

124124
# Credits
125125

126-
This project was established at [TGS](https://www.tgs.com/). Original authors
127-
and current maintainers are [Altay Sansal](https://github.com/tasansal) and
128-
[Sri Kainkaryam](https://github.com/srib); with the support of many more great
129-
colleagues.
126+
This project was established at [TGS](https://www.tgs.com/). Current maintainer is
127+
[Altay Sansal](https://github.com/tasansal) with the support of
128+
many more great colleagues.
130129

131130
This project template is based on [@cjolowicz]'s [Hypermodern Python Cookiecutter]
132131
template.
@@ -151,8 +150,8 @@ template.
151150

152151
<!-- github-only -->
153152

154-
[license]: https://github.com/TGSAI/mdio-python/blob/main/LICENSE
153+
[apache 2.0 license]: https://github.com/TGSAI/mdio-python/blob/main/LICENSE
155154
[contributor guide]: https://github.com/TGSAI/mdio-python/blob/main/CONTRIBUTING.md
156-
[usage]: https://mdio-python.readthedocs.io/en/latest/usage.html
157-
[reference]: https://mdio-python.readthedocs.io/en/latest/reference.html
158-
[install]: https://mdio-python.readthedocs.io/en/latest/installation.html
155+
[command-line usage]: https://mdio-python.readthedocs.io/en/latest/usage.html
156+
[api reference]: https://mdio-python.readthedocs.io/en/latest/reference.html
157+
[installation instructions]: https://mdio-python.readthedocs.io/en/latest/installation.html

docs/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ end-before: <!-- github-only -->
44
---
55
```
66

7-
[license]: license
7+
[apache 2.0 license]: license
88
[contributor guide]: contributing
9-
[command-line reference]: usage
9+
[command-line usage]: usage
10+
[api reference]: reference
11+
[installation instructions]: installation
1012

1113
```{toctree}
1214
---

docs/reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ and
3333
```{eval-rst}
3434
.. automodule:: mdio.converters.segy
3535
:members:
36+
:exclude-members: grid_density_qc, parse_index_types
3637
3738
.. automodule:: mdio.converters.mdio
3839
:members:

0 commit comments

Comments
 (0)