mirror of
https://github.com/galaxyproject/galaxy.git
synced 2026-09-24 16:30:27 +08:00
John Chilton
02380a88a8
- Don't use 'sphinx.ext.autodoc' if existing option GALAXY_DOCS_SKIP_SOURCE=1 is used to speed up the build. - Add a matching option to GALAXY_DOCS_SKIP_SOURCE called GALAXY_DOCS_SKIP_RELEASES to further speed up development of just the core rst/md docs. - Fix an markdown link added to the rst index this release.
69 lines
1.6 KiB
ReStructuredText
69 lines
1.6 KiB
ReStructuredText
Galaxy Documentation
|
|
********************
|
|
|
|
Galaxy is an open, web-based platform for accessible, reproducible, and transparent computational biomedical research.
|
|
|
|
For more information on the Galaxy Project, please visit the https://galaxyproject.org
|
|
|
|
The community maintains `a list of awesome Galaxy resources <https://github.com/galaxyproject/awesome-galaxy/>`__ related to all aspects of Galaxy.
|
|
|
|
|
|
* :ref:`release-docs`
|
|
* :ref:`admin-docs`
|
|
* :ref:`dev-docs`
|
|
* :ref:`about-docs`
|
|
|
|
.. _release-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Release Notes
|
|
|
|
Releases <releases/index>
|
|
|
|
.. _admin-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Admin Documentation
|
|
|
|
Administration <admin/index>
|
|
Special topics <admin/special_topics/index>
|
|
|
|
.. _dev-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Developer Documentation
|
|
|
|
Development <dev/index>
|
|
Galaxy API <api_doc>
|
|
Tool Shed API <ts_api_doc>
|
|
Application Documentation <lib/modules>
|
|
|
|
.. _about-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: About Project
|
|
|
|
Project Governance <project/organization>
|
|
Issue Management <project/issues>
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
|
|
Building this Documentation
|
|
===========================
|
|
|
|
If you have your own copy of the Galaxy source code, you can also generate your own version of this documentation. Run the following command from the Galaxy's root:
|
|
|
|
::
|
|
|
|
$ make docs
|
|
|
|
The generated documentation will be in ``doc/build/html/`` and can be viewed with a web browser. Note that you will need to install Sphinx and other module dependencies which are listed in the Makefile in the Galaxy root folder.
|