Commit Graph
39 Commits
Author SHA1 Message Date
John Chilton b598bff3e0 Big warning box about distributed object stores being required. 2024-05-20 12:19:01 -04:00
Nicola Soranzo ed5b0023ff Fix search and version menu in docs
The `html_theme_path` option should not be used any more with
sphinx-rtd-theme since it switches off the theme's ability to
automatically enable the sphinxcontrib-jquery extension, i.e.
jQuery is not loaded in the web pages when building the docs with
Sphinx >=6.

xref: https://github.com/readthedocs/sphinx_rtd_theme/issues/1434#issuecomment-1472671651

Also replace the deprecated `canonical_url` theme option with
Sphinx's `html_baseurl`.

xref: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-canonical_url
2024-04-04 02:39:52 +01:00
Nicola Soranzo c2eebd0bbe Fix `'myst' cross-reference target not found` warnings
Also:
- Use auto-generated table of contents in tool schema
2023-03-27 15:07:21 +01:00
Nicola Soranzo 0f70c68fd9 Migrate to MyST-Parser for Markdown docs
replacing deprecated recommonmark.

Fix https://github.com/galaxyproject/galaxy/issues/13005 .

Also:
- Drop not very useful ``doc/source/dev/file_upload.md`` .
- Small doc and link fixes.
2023-03-27 15:01:27 +01:00
Nicola Soranzo 921e5da2e6 Lint 2 previously excluded files with black and isort 2023-01-16 14:34:56 +00:00
Dannon Baker 623a5e165a Apply black formatting.
Apply isort.
2022-02-03 07:42:20 -05:00
John Chilton 61188ca27b Hook requests up to intersphinx. 2021-01-12 09:29:53 -05:00
John Chilton 386470789f A couple new ways to speed up doc building locally. 2021-01-12 09:29:53 -05:00
John Chilton 02380a88a8 A couple small fixes for docs generation.
- 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.
2021-01-10 18:52:26 -05:00
Nicola Soranzo 9d74bba7fb Drop support for retired Python 3.5
Upgrade syntax using `pyupgrade --py36-plus` .

Manually drop several `six` imports.

Also:
- Remove broken pr_cache in scripts/bootstrap_history.py
- Fix broken prefix removal in lib/galaxy/tool_util/deps/mulled/mulled_build.py
2020-10-07 11:52:13 +01:00
Nicola Soranzo 77d8dac19a Various doc fixes
- Merge invisible `doc/source/admin/reports.md` into
  `doc/source/admin/reports.rst`
- Misc fixes and cleanups
2020-02-07 02:37:57 +00:00
Nicola Soranzo e97634739d Build tool XML schema docs using `sphinx_markdown_tables`
instead of converting the Markdown to reStructuredText with pandoc.

Fix the broken tables, but code inside tables is not coloured as
in the rest of the document.
2019-02-06 17:27:48 +00:00
Nicola Soranzo e725f8423a Disable auto toctree for Markdown docs. Doc syntax fixes
recommonmark allows now to use the `.md` extension for cross referencing
other documents, which also works on GitHub.
2019-02-06 17:12:06 +00:00
Nicola Soranzo 8915766275 Do not exclude releases docs when using `GALAXY_DOCS_SKIP_SOURCE`
They are quite fast to build.
2019-01-14 22:45:34 +00:00
Nicola Soranzo 4bb6f18b30 Do not build rst files starting with '_' 2019-01-14 22:45:34 +00:00
Nicola Soranzo ce5895f585 Update recommonmark configuration in Sphinx
See https://github.com/rtfd/recommonmark/pull/113
2019-01-14 22:45:34 +00:00
Nicola Soranzo ad02c53154 Fix many links 2018-09-03 14:34:13 +01:00
Dannon Baker a54681e8c6 Merge pull request #5334 from natefoo/doc-versioning
Documentation version selection
2018-02-15 14:38:16 -05:00
Nate Coraor 141ac1eabc Move simpleversioning config to a separate file that can be written to
conf.py by Jenkins
2018-01-18 10:00:56 -05:00
Nate Coraor 8ecddefd09 WIP for linking doc versions 2018-01-17 17:04:13 -05:00
Nate Coraor e0891cac35 Add intersphinx mapping to the Python 2.7 documentation 2018-01-10 16:25:26 -05:00
John Chilton d24b545d70 Migrate documentation for setting up a production instance to Galaxy.
This is a bugfix for the future bug of missing documentation for 17.09 and before. 18.01 will require a significant rewrite of these pages for the uWSGI and configuration changes to Galaxy and the release_17.09 branch of these docs is now being hosted https://docs.galaxyproject.org/en/release_17.09/, so backporting this configuration documentation will allow us to provide permenant links to this 17.09 varaint of all this documentation (with information about paste and galaxy.ini for instance).

This content currently includes:

- the production configuration page
- the cluster configuration page
- the job configuration page
- the scaling information page
- the ftp configuration page
- the top-level nginx page (for external auth content still linking out to the hub)
- the top-level apache page (for external auth content still linking out to the hub)
- the job metrics configuration page

Includes small tweaks to sphinx documentation generation.

- Add a quick build mode that skips source generation / Python docs (export GALAXY_DOCS_SKIP_SOURCE=1 to build this way). This speeds up review of core Sphinx docs.
- Use AutoStructify for better Markdown integration.

Updates to the documentation above and beyond what is on the corresponding Hub pages to reflect more of the state of art as of 17.09 including:

- Update the job configuration page with information about XML macros.
- Mention and link to newer style resubmission condition expressions (not just an enumerated string anymore).
- Updated list of dynamic job runner configuration parameters.
- Mention the ``raw`` attribute for ``env`` directives in the job configuration page.
- Mention the ``total_walltime`` limit added in #3217.
- Drop mentions of older URL-based job conf configuration stuff.
- Mention newer Local and Paramiko based shell runners in CLI section.
- Mention newer slurm job styles in CLI section.
- Improved Pulsar links.
- Fix dataset security link in Apache display sites config.
- Update job metrics page to link to a new Github issue instead of old Trello issues.
2017-12-05 22:04:20 -05:00
Martin Cech b4feb85f11 improve accessibility of API docs
for both Galaxy and TS
2017-03-27 15:21:37 -04:00
Martin Cech 66a02b6af1 modify our docs in preparation for restructuring
start moving admin content from old wiki
2017-03-10 12:06:24 -05:00
Nicola Soranzo 83760e6a01 Don't skip __init__() methods when generating docs 2016-11-02 20:28:27 +00:00
Nicola Soranzo 527e332aa3 Fix a bunch of errors reported by Sphinx 2016-10-24 19:42:19 +01:00
Remi Marenco 3e737c99ea Add Galaxy Architecture slides in .md
+ the plumbing for slides creation

Init of #2244, second part: Python converter md to html + wip on GCC 2015 talk conversion
Add the 2. Galaxy app architecture. Need images
Add the 3. Galaxy components and object model
Add more content in md
Fix linting error by adding newline at the end of build_slideshow.py
Moved the galaxyArchitecture.md into a folder dedicated to it
Add 7th and 17th image + add style.css to have a better management of layout + added first slide as the first in GCC2015 slide
Set properly the CSS used in the whole presentation + add special to p and first slide
Add special orange for regular text and green emphasis (emphasis_2_galaxy)
Changed the font to PT Sans
Add 3. with images + few modifications
Removed the images integrated using background-image by now Markdown imaging (still need work, image's size seems not good by default
Add Makefile target to build architecture slides...
2016 Updates to 2015 architecture talk.
More intro slides for Galaxy architecture.
Update author line.
Progress on architecture slides...
 - Improved styling (use Oxygen - closer to Galaxy font)
 - Add ability to generate SVG diagrams to slide infrastructure
 - Add newer client-server sequence diagram based on that.
Improved logging when there are problems with SQL migrations.
More misc work on architecture talk.
More images, slides, slide formatting, and initial work on an IPython notebook.
Improved styling for architecture slides...
Updates to architecture talk...
- Infrastructure for building class diagrams with plantuml
- Bring in move SVGs from last year's google docs.
- Fill out section on client architecture.
More work on slides for architecture talk.
Add startup_output.
Replace mermaid diagrams with plantuml diagrams.
Fill out these diagrams more and style them for a black background in Galaxy oranges.
2016-10-17 14:02:06 -04:00
Nicola Soranzo c01cf85d45 Use __file__ when adding paths to sys.path instead of os.getcwd() .
Also insert additional paths in position 1 unless strictly necessary.
2015-09-11 19:05:37 +01:00
Nicola Soranzo c2917a78f8 Change html_theme to sphinx_rtd_theme to fix left sidebar. 2015-06-29 17:36:24 +01:00
Nicola Soranzo ee0ce040ce Update to sphinx-apidoc v1.3.1 .
sphinx-apidoc -M -o doc/source/lib/ lib/
2015-06-29 15:39:12 +01:00
Nicola Soranzo 71b963b2d0 Fix a few tracebacks when building docs with 'make -C doc/ html' . 2015-06-29 15:19:49 +01:00
Martin Cech 5a9259d773 updated sphinx documentation: added managers; added new API controllers; cleanup 2014-10-22 17:55:45 -04:00
Dave Clements b808d4b935 Added numpy to mock modules list. Readthedocs of galaxy-central is broken, and it's complaining about numpy. So, try adding it to mock modules list and see if that helps. 2012-11-06 09:31:28 -08:00
Dave Clements 5338d778b4 Pared Sphinx's mock module list down to those that actually get rid of errors at ReadTheDocs. 2012-11-03 10:25:21 -07:00
Dave Clements 2031da8f68 Took out mock modules that weren't helping from Sphinx config file. 2012-11-03 10:10:15 -07:00
Dave Clements 7ca742c187 More changes to get Sphinx to run with fewer erros on ReadTheDocs.org. 2012-11-03 10:00:12 -07:00
Dave Clements fed96397ef Added ReadTheDocs section to Sphinx's conf.py. This lists modules that need to be mocked up, Ithink. 2012-11-03 09:34:06 -07:00
Dave Clements 9ece96cc8f All Sphinx related changes:
- Changed from Galaxy Documentation to Galaxy Code Documentation to be clearer
- Dropped galaxy.jobs.rules, as it is now empty.
2012-11-03 08:51:09 -07:00
Dannon Baker 1a3a17056e Initial commit of Galaxy Documentation. 2012-06-13 11:31:00 -04:00