Skip to content
Merged
Show file tree
Hide file tree
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 Apr 20, 2026
d2c5482
moving away from requirements.txt to pyproject.toml
SunilSimha Apr 20, 2026
9ad757e
more messages for imports
SunilSimha Apr 20, 2026
0b18a95
No need for seaborn or progressbar
SunilSimha Apr 20, 2026
8cc47e0
no progressbar here too
SunilSimha Apr 20, 2026
7b44a15
not sure what this is but the sphinx magic works as expected
SunilSimha Apr 20, 2026
18327b2
updated docs
SunilSimha Apr 20, 2026
26648b8
Moving to pyproject.toml
SunilSimha Apr 20, 2026
3ef60fa
Getting rid of threedhst imports. Never worked without tweaks
SunilSimha Apr 20, 2026
d6bda69
Updates to tox for CI testing.
SunilSimha Apr 20, 2026
ef0a972
gentler aemulus install warning
SunilSimha Apr 21, 2026
e91fd15
No need to deal with the headache of optional packages
SunilSimha Apr 21, 2026
16bdfe8
unnecesary python -m
SunilSimha Apr 21, 2026
7f30324
astro-datalab shouldn't be optional.
SunilSimha Apr 21, 2026
7d04fde
more complete docs
SunilSimha Apr 21, 2026
f20c449
Fix lightweight tox numpy env test collection failures
Copilot Apr 21, 2026
fbdf57b
Constrain lightweight tox numpy envs to stable import-safe test target
Copilot Apr 21, 2026
6d10108
Move dev tooling to optional deps and broaden lightweight tox tests
Copilot Apr 21, 2026
168a402
Revert "more complete docs"
SunilSimha Apr 21, 2026
93e8880
reordering docs and fixing docstrings
SunilSimha Apr 21, 2026
f494310
duplicates
SunilSimha Apr 21, 2026
c27df2f
no skip install?
SunilSimha Apr 21, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: CI Tests
on:
push:
branches:
- master
- main
pull_request:
Comment on lines 4 to 7
Copy link

Copilot AI Apr 21, 2026

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 via frb/requirements.txt plus manual pip install git+... steps. With the move to pyproject.toml, this is now out of sync with the documented/supported install flow (pip install -e . / extras) and with the deprecation notice in frb/requirements.txt. Consider switching CI to pip install -e .[dev] (and any other extras needed) so CI exercises the new packaging metadata.

Copilot uses AI. Check for mistakes.

env:
Expand Down
13 changes: 13 additions & 0 deletions docs/api/analysis.kcwi.rst
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``.
15 changes: 15 additions & 0 deletions docs/api/analysis.rst
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
8 changes: 8 additions & 0 deletions docs/api/associate.frbassociate.rst
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.
7 changes: 7 additions & 0 deletions docs/api/associate.frbs.rst
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:
7 changes: 7 additions & 0 deletions docs/api/associate.gen_pox_table.rst
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:
19 changes: 5 additions & 14 deletions docs/api/associate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,9 @@ frb.associate - FRB-Galaxy Association
Submodules
----------

frb.associate.frbassociate - FRBAssociate Class
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1

.. automodule:: frb.associate.frbassociate
:members:
:undoc-members:
:show-inheritance:

frb.associate.frbs - FRB Association Data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: frb.associate.frbs
:members:
:undoc-members:
:show-inheritance:
associate.frbassociate
associate.frbs
associate.gen_pox_table
7 changes: 7 additions & 0 deletions docs/api/builds.build_fg.rst
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:
7 changes: 7 additions & 0 deletions docs/api/builds.build_frbs.rst
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:
7 changes: 7 additions & 0 deletions docs/api/builds.build_hosts.rst
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:
7 changes: 7 additions & 0 deletions docs/api/builds.build_path.rst
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:
10 changes: 10 additions & 0 deletions docs/api/builds.build_specdb.rst
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.
8 changes: 8 additions & 0 deletions docs/api/builds.old_build_frbs.rst
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.
7 changes: 7 additions & 0 deletions docs/api/builds.old_build_hosts.rst
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:
22 changes: 22 additions & 0 deletions docs/api/builds.rst
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
7 changes: 7 additions & 0 deletions docs/api/builds.utils.rst
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:
7 changes: 7 additions & 0 deletions docs/api/defs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
frb.defs
========

.. automodule:: frb.defs
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/dm.cosmic.rst
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:
7 changes: 7 additions & 0 deletions docs/api/dm.dm_ism_healpix_map.rst
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:
7 changes: 7 additions & 0 deletions docs/api/dm.host.rst
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:
8 changes: 8 additions & 0 deletions docs/api/dm.igm.rst
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.
7 changes: 7 additions & 0 deletions docs/api/dm.mcmc.rst
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:
7 changes: 7 additions & 0 deletions docs/api/dm.prob_dmz.rst
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:
Loading
Loading