-
Notifications
You must be signed in to change notification settings - Fork 33
Installation fix and revamped docs #233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
ca7c8dc
don't raise errors. Just print warnings
SunilSimha d2c5482
moving away from requirements.txt to pyproject.toml
SunilSimha 9ad757e
more messages for imports
SunilSimha 0b18a95
No need for seaborn or progressbar
SunilSimha 8cc47e0
no progressbar here too
SunilSimha 7b44a15
not sure what this is but the sphinx magic works as expected
SunilSimha 18327b2
updated docs
SunilSimha 26648b8
Moving to pyproject.toml
SunilSimha 3ef60fa
Getting rid of threedhst imports. Never worked without tweaks
SunilSimha d6bda69
Updates to tox for CI testing.
SunilSimha ef0a972
gentler aemulus install warning
SunilSimha e91fd15
No need to deal with the headache of optional packages
SunilSimha 16bdfe8
unnecesary python -m
SunilSimha 7f30324
astro-datalab shouldn't be optional.
SunilSimha 7d04fde
more complete docs
SunilSimha f20c449
Fix lightweight tox numpy env test collection failures
Copilot fbdf57b
Constrain lightweight tox numpy envs to stable import-safe test target
Copilot 6d10108
Move dev tooling to optional deps and broaden lightweight tox tests
Copilot 168a402
Revert "more complete docs"
SunilSimha 93e8880
reordering docs and fixing docstrings
SunilSimha f494310
duplicates
SunilSimha c27df2f
no skip install?
SunilSimha File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ name: CI Tests | |
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
| - main | ||
| pull_request: | ||
|
|
||
| env: | ||
|
|
||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| frb.analysis.kcwi | ||
| ================= | ||
|
|
||
| .. automodule:: frb.analysis.kcwi | ||
|
|
||
| .. note:: | ||
| Optional dependencies: ``pyregion`` and ``spectral-cube`` are required | ||
| for full KCWI functionality. | ||
|
|
||
| .. note:: | ||
| Member-level API expansion is intentionally omitted here because several | ||
| upstream function docstrings are not valid reStructuredText and trigger | ||
| docutils parse errors during ``make html``. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| frb.analysis | ||
| ============ | ||
|
|
||
| .. automodule:: frb.analysis | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: | ||
|
|
||
| Submodules | ||
| ---------- | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| analysis.kcwi |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| frb.associate.frbassociate | ||
| ========================== | ||
|
|
||
| .. automodule:: frb.associate.frbassociate | ||
|
|
||
| .. note:: | ||
| Member-level API expansion is intentionally omitted here to keep | ||
| ``make html`` stable with current upstream docstring formatting. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.associate.frbs | ||
| ================== | ||
|
|
||
| .. automodule:: frb.associate.frbs | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.associate.gen_pox_table | ||
| =========================== | ||
|
|
||
| .. automodule:: frb.associate.gen_pox_table | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.builds.build_fg | ||
| =================== | ||
|
|
||
| .. automodule:: frb.builds.build_fg | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.builds.build_frbs | ||
| ===================== | ||
|
|
||
| .. automodule:: frb.builds.build_frbs | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.builds.build_hosts | ||
| ====================== | ||
|
|
||
| .. automodule:: frb.builds.build_hosts | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.builds.build_path | ||
| ===================== | ||
|
|
||
| .. automodule:: frb.builds.build_path | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| frb.builds.build_specdb | ||
| ======================= | ||
|
|
||
| .. automodule:: frb.builds.build_specdb | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: | ||
|
|
||
| .. note:: | ||
| Optional dependency: ``specdb`` is required to build spectroscopic databases. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| frb.builds.old_build_frbs | ||
| ========================= | ||
|
|
||
| .. automodule:: frb.builds.old_build_frbs | ||
|
|
||
| .. note:: | ||
| Member-level API expansion is intentionally omitted here to avoid | ||
| docstring parsing warnings in the current codebase. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.builds.old_build_hosts | ||
| ========================== | ||
|
|
||
| .. automodule:: frb.builds.old_build_hosts | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| frb.builds | ||
| ========== | ||
|
|
||
| .. automodule:: frb.builds | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: | ||
|
|
||
| Submodules | ||
| ---------- | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| builds.build_fg | ||
| builds.build_frbs | ||
| builds.build_hosts | ||
| builds.build_path | ||
| builds.build_specdb | ||
| builds.utils | ||
| builds.old_build_frbs | ||
| builds.old_build_hosts |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.builds.utils | ||
| ================ | ||
|
|
||
| .. automodule:: frb.builds.utils | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.defs | ||
| ======== | ||
|
|
||
| .. automodule:: frb.defs | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.dm.cosmic | ||
| ============= | ||
|
|
||
| .. automodule:: frb.dm.cosmic | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.dm.dm_ism_healpix_map | ||
| ========================= | ||
|
|
||
| .. automodule:: frb.dm.dm_ism_healpix_map | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.dm.host | ||
| =========== | ||
|
|
||
| .. automodule:: frb.dm.host | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| frb.dm.igm | ||
| ========== | ||
|
|
||
| .. automodule:: frb.dm.igm | ||
|
|
||
| .. note:: | ||
| Member-level API expansion is intentionally omitted here to avoid | ||
| docstring parsing warnings from legacy formatting. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.dm.mcmc | ||
| =========== | ||
|
|
||
| .. automodule:: frb.dm.mcmc | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| frb.dm.prob_dmz | ||
| =============== | ||
|
|
||
| .. automodule:: frb.dm.prob_dmz | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although this workflow was updated to run on
main, it still installs dependencies viafrb/requirements.txtplus manualpip install git+...steps. With the move topyproject.toml, this is now out of sync with the documented/supported install flow (pip install -e ./ extras) and with the deprecation notice infrb/requirements.txt. Consider switching CI topip install -e .[dev](and any other extras needed) so CI exercises the new packaging metadata.