Skip to content

intersphinx xref physical types#223

Closed
nstarman wants to merge 6 commits into
adrn:mainfrom
nstarman:intersphinx-physical-types
Closed

intersphinx xref physical types#223
nstarman wants to merge 6 commits into
adrn:mainfrom
nstarman:intersphinx-physical-types

Conversation

@nstarman

@nstarman nstarman commented May 1, 2021

Copy link
Copy Markdown
Contributor

Signed-off-by: Nathaniel Starkman (@nstarman) nstarkman@protonmail.com

Describe your changes

Ahh. This solution will require astropy v4.3+ for the physical types. I'll get back to this later, when I update my PR to sphinx-astropy.
Done. Now need to get RTD to compile with astropy v4.3. hmm.... any suggestions?
without building RTD in astropy v4.3+, the links are not live. https://gala-astro--223.org.readthedocs.build/en/223/

Current state : Gala doesn't work with astropy dev #222

Checklist

  • Did you add tests?
  • Did you add documentation for your changes?
  • Did you reference any relevant issues?
  • Did you add a changelog entry? (see CHANGES.rst)
  • Are the CI tests passing?
  • Is the milestone set?

Requires: #224

@nstarman nstarman force-pushed the intersphinx-physical-types branch 10 times, most recently from 3264256 to b58c44f Compare May 2, 2021 16:09
Comment thread .rtd-environment.yml
- pip
- pip:
- -e .[docs]
- astropy @ git+https://github.com/astropy/astropy.git

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

need to figure out a better way of setting astropy >= 4.3

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@adrn, any suggestions?

@adrn adrn May 5, 2021

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Fine to pin this as is for now. I want to hold off on requiring astropy >= 4.3 until at least gala v1.5 (next release is v1.4, hopefully within the next few weeks). By then, 4.3 should be out and we can change this to astropy>=4.3

Comment thread setup.cfg
sphinx-astrorefs
sphinx_automodapi
sphinx_astropy
sphinx_astropy @ git+https://github.com/nstarman/sphinx-astropy.git@intersphinx-xref-physical-types

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

TODO: change when PR merged.

nstarman added 6 commits May 5, 2021 15:20
Signed-off-by: Nathaniel Starkman (@nstarman) <nstarkman@protonmail.com>

oops

Signed-off-by: Nathaniel Starkman (@nstarman) <nstarkman@protonmail.com>
Signed-off-by: Nathaniel Starkman (@nstarman) <nstarkman@protonmail.com>
Signed-off-by: Nathaniel Starkman (@nstarman) <nstarkman@protonmail.com>
Signed-off-by: Nathaniel Starkman (@nstarman) <nstarkman@protonmail.com>
Signed-off-by: Nathaniel Starkman (@nstarman) <nstarkman@protonmail.com>
Signed-off-by: Nathaniel Starkman (@nstarman) <nstarkman@protonmail.com>
@nstarman nstarman force-pushed the intersphinx-physical-types branch from 25a161c to 4d51b7f Compare May 5, 2021 19:22
@adrn

adrn commented Aug 9, 2021

Copy link
Copy Markdown
Owner

Thanks for starting on this! I updated the conf.py in #243 and think this PR isn't necessary any more? But of course I still need to go through and update all of the physical type specifications in the docstrings... Let me know if you disagree and we can re-open this!

@adrn adrn closed this Aug 9, 2021
@nstarman

nstarman commented Aug 9, 2021

Copy link
Copy Markdown
Contributor Author

Agreed. #243 does exactly what of sphinx-astropy intends. The only thing is that sphinx-astropy needs to be >= v1.4

@nstarman nstarman deleted the intersphinx-physical-types branch August 9, 2021 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants