https://github.com/BioContainers/edu

BioContainers Documentation.
https://github.com/BioContainers/edu

bioconda biocontainers containers documentation documentation-code readthedocs travis

Last synced: about 1 month ago
JSON representation

BioContainers Documentation.

• Host: GitHub
• URL: https://github.com/BioContainers/edu
• Owner: BioContainers
• Created: 2016-10-19T20:49:22.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-25T13:52:15.000Z (5 months ago)
• Last Synced: 2024-08-01T12:32:21.807Z (4 months ago)
• Topics: bioconda, biocontainers, containers, documentation, documentation-code, readthedocs, travis
• Language: JavaScript
• Homepage: http://biocontainers-edu.biocontainers.pro
• Size: 34.3 MB
• Stars: 7
• Watchers: 6
• Forks: 24
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.rst

Awesome Lists containing this project

• awesome-starred - BioContainers/edu - BioContainers Documentation. (documentation)

README

        
BioContainers Documentation

=============================

The BioContainers documentation is generated using readthedocs and sphinx. The final version of the documentation is deployed in: https://biocontainers-edu.readthedocs.io/en/latest/

If you want to contribute with the documentation please do a Pull Request (PR) in the branch ``read_docs``.

The documentation source files `.rst` are stored in the **docs** folder.

If you want to build the project locally, you need to follow these steps:

First Steps with Sphinx

-------------------------

Install Sphinx, either from a distribution package or from PyPI with

```bash

$ pip install Sphinx

```

To build HTML docs in the `build` directory you chose. Execute make without an argument to see which targets are available.

```bash

$ make html

```