Skip to content

Commit

Permalink
Fix analysis tools front page formatting issue
Browse files Browse the repository at this point in the history
  • Loading branch information
leeskelvin committed May 10, 2023
1 parent 012a343 commit ee25a4f
Showing 1 changed file with 8 additions and 47 deletions.
55 changes: 8 additions & 47 deletions doc/lsst.analysis.tools/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,68 +32,29 @@ For a tutorial on working with

Need Help?
==========
If you have access to slack, project members and in kind contributers should have and get stuck with ``analysis_tools`` then feel free to reach out to the ``#rubinobs-analysis-tools``
channel on slack and hopefully someone will help you!

Another way to get help is to write a post on `The Community Forum <https://community.lsst.org/>`_.
The first place to check for more information is the :ref:`FAQs <analysis-tools-faqs>` page which contains some helpful hints.
More will be added to this page over time; if you find something that you think should be added here then please do!

A first place for more information is the :ref:`FAQs <analysis-tools-faqs>` page which
contains some helpful hints. More will be added to this page over time, if you find something that you think
should be added here then please do!

.. _lsst.analysis_tools-pyapi:

Python API Reference
====================

.. automodapi:: lsst.analysis.tools
:include-all-objects:
.. automodapi:: lsst.analysis.tools.actions.plot
.. automodapi:: lsst.analysis.tools.actions.vector
.. automodapi:: lsst.analysis.tools.actions.scalar
Project members and in-kind contributors may ask for further help via the ``#rubinobs-analysis-tools`` channel on the LSSTC Slack workspace.
All users of the analysis tools package, including community members, are also welcome to post any questions you might have on the `Community Forum <https://community.lsst.org/>`_.

.. _lsst.analysis_tools-contributing:

Contributing
============

The ``lsst.analysis.tools`` package is developed at
`github.com/lsst/analysis_tools <https://github.com/lsst/analysis_tools>`_.

<<<<<<< HEAD
Jira issues relating to this package can be found using the
`analysis_tools <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20analysis_tools>`_
component.
=======
.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
.. .. toctree::
.. :maxdepth: 1
.. .. _lsst.analysis.tools-scripts:
The ``lsst.analysis.tools`` package is developed at `github.com/lsst/analysis_tools <https://github.com/lsst/analysis_tools>`_.

.. Script reference
.. ================
Jira issues relating to this package can be found using the `analysis_tools <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20analysis_tools>`_ component.

.. .. TODO: Add an item to this toctree for each script reference topic in the scripts subdirectory.
.. .. toctree::
.. :maxdepth: 1
.. .. _lsst.analysis.tools-pyapi:
.. _lsst.analysis_tools-pyapi:

Python API reference
Python API Reference
====================

.. NOTE: Skip the type definitions that cause the pipelines docs build to fail.
.. automodapi:: lsst.analysis.tools
:no-main-docstr:
:no-inheritance-diagram:
:include-all-objects:
.. automodapi:: lsst.analysis.tools.actions.plot
:no-inheritance-diagram:
.. automodapi:: lsst.analysis.tools.actions.vector
:no-inheritance-diagram:
.. automodapi:: lsst.analysis.tools.actions.scalar
:no-inheritance-diagram:
>>>>>>> 2de19a1 (Add more pages to the docs)

0 comments on commit ee25a4f

Please sign in to comment.