Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

sphinx:
configuration: docs/conf.py

python:
install:
- method: pip
path: .
- requirements: docs/requirements.txt

formats:
- pdf
- epub
Empty file added docs/_static/.gitkeep
Empty file.
Empty file added docs/_templates/.gitkeep
Empty file.
26 changes: 26 additions & 0 deletions docs/api/associate.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
frb.associate - FRB-Galaxy Association
=======================================

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

Submodules
----------

frb.associate.frbassociate - FRBAssociate Class
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

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

.. automodule:: frb.associate.frbs
:members:
:undoc-members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/api/dlas.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
frb.dlas - Intervening Galaxies (DLAs)
======================================

Assessing impact of intervening galaxies (DLAs)
on FRB measurements, based on Prochaska & Neeleman 2017.

.. automodule:: frb.dlas
:members:
:undoc-members:
:show-inheritance:
Loading