Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rst fixes #50

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
trivial: fix underline too short warnings
these warnings clutter up the sphinx output
and make it hard to see real problems
kzuberi committed Jan 27, 2023
commit 546ba066b0ef1ba9f51e0f6d58f618c9b911ee2d
8 changes: 4 additions & 4 deletions docs/conda_integration.rst
Original file line number Diff line number Diff line change
@@ -97,7 +97,7 @@ We utilize `mulled <https://github.com/mulled/mulled>`_ with `involucro <https:/
Here is a short introduction:

Search for conda-based containers
~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This will search for containers in the biocontainers organisation.

@@ -106,7 +106,7 @@ This will search for containers in the biocontainers organisation.
$ mulled-search -s vsearch -o biocontainers

Build all packages from bioconda from the last 24h
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The BioConda community is building a container for every package they create with a command similar to this:

@@ -117,7 +117,7 @@ The BioConda community is building a container for every package they create wit
--involucro-path ./involucro --recipes-dir ./bioconda-recipes --diff-hours 25 build

Building Docker containers for local Conda packages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Conda packages can be tested with creating a busybox-based container for this particular package in the following way.
This also demonstrates how you can build a container locally and on-the-fly.
@@ -148,7 +148,7 @@ The ``--0`` indicates the build version of the conda package. It is recommended
you will override already existing images. For Python Conda packages this extension might look like this ``--py35_1``.

Build, test and push a conda-forge package to biocontainers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note:: You need to have write access to the biocontainers repository

2 changes: 1 addition & 1 deletion docs/examples.rst
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ BioContainers in Examples
In this section we provide a set of examples about how to use BioContainers in your analysis. Please feel free to contribute to this help with your own examples.

Peptide MS search engine (Tide)
-------------------------
-------------------------------

Let’s run a proteomics search engine to identified proteins using `Tide <http://crux.ms/commands/tide-index.html>`_. Proteomics data analysis is dominated by database-based search engines strategies. Amount Search Engines, **Tide** is one of the most popular nowadays.

2 changes: 1 addition & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ Getting started with Docker
============================

Docker Configuration
---------------
--------------------

`Docker <https://www.docker.com/>`__ is the world’s leading platform for software containerization. Docker includes multiple tools and components such as: `docker <https://docs.docker.com/>`__, `docker engine <https://docs.docker.com/engine/installation/>`__, `docker hub <https://docs.docker.com/docker-hub/>`__.

2 changes: 1 addition & 1 deletion docs/running_example.rst
Original file line number Diff line number Diff line change
@@ -85,7 +85,7 @@ Now that you have enough information to start comparing sequences using BLAST, y
We hope that this short example can shed some light on how important and easy it is to run containerized software.

Run everything in one go
~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: bash

2 changes: 1 addition & 1 deletion docs/singularitycontainers.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. _singularitycontainers

Using Singularity containers
=========================
============================

6 changes: 3 additions & 3 deletions docs/what_is_biocontainers.rst
Original file line number Diff line number Diff line change
@@ -57,7 +57,7 @@ When a container is deployed and the developer closes the issue in GitHub, the u
.. note:: You can read other sections about :doc:`conda_integration` and :doc:`singularitycontainers`

Reporting a problem with a container
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If the user finds a problem with a container an issue should be opened in
the `container repository <https://github.com/BioContainers/containers/issues>`__, the user should use the **broken tag** (`see tags <https://github.com/BioContainers/containers/labels>`_). Developers of the project will pick-up the issue and deploy a new version of the container. A message will be delivered when the container has been fixed.
@@ -74,7 +74,7 @@ BioContainers build the docker containers from two different sources the `Docker
In order to be able to contribute to BioContainers you should be able to create a BioConda recipe or a Dockerfile recipe.

Create a BioConda recipe
~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~

.. note:: Before you start please read the Conda documentation and `how to setup conda in your machine <https://conda.io/projects/conda-build/en/latest/source/user-guide/tutorials/index.html>`__

@@ -87,7 +87,7 @@ In summary should follow these steps:
After the PR gets merged, a Conda package gets created and the corresponding docker container get pushed into `Quay.io Registry <https://quay.io/organization/biocontainers>`__ and the `BioContainers Registry <https://biocontainers.pro/#/registry>`__

Create a Dockerfile recipe
~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~

This is a standard template for creating a new Dockerfile for BioContainers: