Skip to content

Update module lists in documentation#2265

Merged
bsipocz merged 2 commits into
astropy:mainfrom
eerovaher:docs-module-lists
Jan 28, 2022
Merged

Update module lists in documentation#2265
bsipocz merged 2 commits into
astropy:mainfrom
eerovaher:docs-module-lists

Conversation

@eerovaher

@eerovaher eerovaher commented Jan 28, 2022

Copy link
Copy Markdown
Member

The module lists in README.rst, docs/index.rst and docs/solarsystem/solarsystem.rst are now alphabetically sorted and agree with each other, and a few broken links in README.rst are fixed. Many links now use https instead of http.

EDIT: The listing in README.rst has been removed altogether because it duplicated docs/index.rst.

Comment thread README.rst

The following modules have been completed using a common API:

* `ALMA Archive <http://astroquery.readthedocs.io/en/latest/alma/alma.html>`_

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder @keflavich whether we should just get rid of this duplicated list in the readme and point to the docs index page instead?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@bsipocz

bsipocz commented Jan 28, 2022

Copy link
Copy Markdown
Member

Thanks @eerovaher!

@bsipocz bsipocz merged commit 31a4164 into astropy:main Jan 28, 2022
@bsipocz bsipocz added this to the v0.4.6 milestone Jan 28, 2022
@eerovaher eerovaher deleted the docs-module-lists branch February 9, 2022 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants