tacc-cloud / agave-docs

Documentation based on sphinx/rst for the Agave project.

Tapis Documentation

Quickstart

1. Create a Python 3 environment
2. Install dependencies pip install -r requirements.txt
3. Build using make html (Mac/Linux) or make.bat html (Windows)

If you pip install sphinx-autobuild, you can use make livehtml which will start a server that watches for source changes and will rebuild/refresh automatically. Go to http://localhost:8000/ to see its output.

reStructuredText help

rST is a bit more onerous than Markdown, but it includes more advanced features like inter-page references/links and a suite of directives.

• Sphinx's primer
• Full Docutils reference
  • also see its Quick rST cheat sheet.
• Online rST editor (it gets some things wrong)
• Other projects that use rST/Sphinx
  • Python: click the "Show Source" under "This Page" in the sidebar.
  • Sphinx: similar
  • Numpy; note that the landing pages are usually coded in HTML and can be found in the templates directory, e.g. Numpy's landing page

agave-docs's Issues

Update to Tapis CLI

In order to deprecate the Bash shell commands, we will need to replace references to the Bash CLI with Tapis CLI equivalents. It might be nice to keep a reference to the old command to help ease users' migration.

Update CLI project URL

The URL in command-line-interface.rst should probably point to either

• https://github.com/TACC-Cloud/tapis-cli-ng
• https://github.com/TACC-Cloud/agave-cli

instead of https://github.com/TACC/agavepy which is more of a python library instead of a CLI.