Update module lists in documentation #2265
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bsipocz
approved these changes
Jan 28, 2022
| @@ -104,58 +104,65 @@ List of Modules | |||
|
|
|||
| The following modules have been completed using a common API: | |||
|
|
|||
| * `ALMA Archive <http://astroquery.readthedocs.io/en/latest/alma/alma.html>`_ | |||
There was a problem hiding this comment.
I wonder @keflavich whether we should just get rid of this duplicated list in the readme and point to the docs index page instead?
There was a problem hiding this comment.
yes, I'd be in favor of that.
It is nice to have this information on the README, but the maintenance cost isn't worth it.
The list in `README.rst` was a duplicate of the list in `docs/index.rst`.
A previously missing module has been added to `docs/index.rst` and the lists are now alphabetically sorted.
eerovaher
force-pushed
the
docs-module-lists
branch
from
6f6f529 to
3651a70
Compare
bsipocz
approved these changes
Jan 28, 2022
|
Thanks @eerovaher! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The module lists in
README.rst,docs/index.rstanddocs/solarsystem/solarsystem.rstare now alphabetically sorted and agree with each other, and a few broken links inREADME.rstare fixed. Many links now usehttpsinstead ofhttp.EDIT: The listing in
README.rsthas been removed altogether because it duplicateddocs/index.rst.