Unverified Commit 8320fd25 authored by Akke Viitanen's avatar Akke Viitanen
Browse files

fix sphinx warnings

parent 89c6e821
Loading
Loading
Loading
Loading
+3 −1
Original line number Diff line number Diff line
@@ -301,9 +301,11 @@ figures_20251024:
	# gband number counts
	python3 src/scripts/plots/plot_number_counts_gband.py fig/number_counts_lsst_gband_20251024.pdf


coverage:
	pytest --cov=src --cov-report=html tests/

documentation:
	sphinx-build -M html ./docs ./build -j4

fig/black_hole_mass_function_redshift.pdf: src/scripts/plots/plot_black_hole_mass_function_redshift.py
	python3 $< $@
+1 −0
Original line number Diff line number Diff line
@@ -55,5 +55,6 @@ autoapi_dirs = ["../src/lsst_inaf_agile"]
autoapi_ignore = ["*/__main__.py", "*/_version.py"]
autoapi_add_toc_tree_entry = False
autoapi_member_order = "bysource"
autoapi_keep_files = True

html_theme = "sphinx_rtd_theme"
+7 −41
Original line number Diff line number Diff line
@@ -3,49 +3,15 @@
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to lsst_inaf_agile's documentation!
========================================================================================

Dev Guide - Getting Started
---------------------------

Before installing any dependencies or writing code, it's a great idea to create
a virtual environment. LINCC-Frameworks engineers primarily use `conda` to
manage virtual environments. If you have conda installed locally, you can run
the following to create and activate a new environment.

.. code-block:: console

   >> conda create env -n <env_name> python=3.12
   >> conda activate <env_name>


Once you have created a new environment, you can install this project for local
development using the following commands:

.. code-block:: console

   >> pip install -e .'[dev]'
   >> pre-commit install
   >> conda install pandoc


Notes:

1) The single quotes around ``'[dev]'`` may not be required for your operating system.
2) ``pre-commit install`` will initialize pre-commit for this local repository, so
   that a set of tests will be run prior to completing a local commit. For more
   information, see the Python Project Template documentation on
   `pre-commit <https://lincc-ppt.readthedocs.io/en/latest/practices/precommit.html>`_.
3) Installing ``pandoc`` allows you to verify that automatic rendering of Jupyter notebooks
   into documentation for ReadTheDocs works as expected. For more information, see
   the Python Project Template documentation on
   `Sphinx and Python Notebooks <https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks>`_.

AGILE: AGN In the LSST Era documentation
===============================================================================

.. toctree::
   :maxdepth: 2
   :hidden:

   Home page <self>
   API Reference <autoapi/index>
   Introduction <self>
   Installation <installation/index>
   User guide <userguide/index>
   Notebooks <notebooks>
   API reference <autoapi/index>
+2 −0
Original line number Diff line number Diff line
Installation
============
+2 −0
Original line number Diff line number Diff line
User guide
==========
Loading