docs/index.rst
.. dockerjudge documentation master file, created by
sphinx-quickstart on Thu Jul 9 19:16:09 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to dockerjudge's documentation!
=======================================
Badges
======
+-----------------+-------------------------------------------------------------------------------------------------------+
| Service | Status |
+=================+=======================================================================================================+
| AppVeyor | .. image:: https://ci.appveyor.com/api/projects/status/qq5br83e4hp7utpo?svg=true |
| | :alt: Build status |
| | :target: https://ci.appveyor.com/project/t9n81yiq9d/dockerjudge |
+-----------------+-------------------------------------------------------------------------------------------------------+
| Azure Pipelines | .. image:: https://dev.azure.com/wangxinhe/wangxinhe/_apis/build/status/wxh06.dockerjudge |
| | :alt: Build Status |
| | :target: https://dev.azure.com/wangxinhe/wangxinhe/_build/latest?definitionId=1 |
| +-------------------------------------------------------------------------------------------------------+
| | .. image:: https://img.shields.io/azure-devops/tests/wangxinhe/wangxinhe/1 |
| | :alt: Azure DevOps tests |
| | :target: https://dev.azure.com/wangxinhe/wangxinhe/_test/analytics?definitionId=1 |
+-----------------+-------------------------------------------------------------------------------------------------------+
| Code Climate | .. image:: https://api.codeclimate.com/v1/badges/dfe666a2140cd3390e56/maintainability |
| | :alt: Maintainability |
| | :target: https://codeclimate.com/github/wxh06/dockerjudge/maintainability |
| +-------------------------------------------------------------------------------------------------------+
| | .. image:: https://api.codeclimate.com/v1/badges/dfe666a2140cd3390e56/test_coverage |
| | :alt: Test Coverage |
| | :target: https://codeclimate.com/github/wxh06/dockerjudge/test_coverage |
+-----------------+-------------------------------------------------------------------------------------------------------+
| FOSSA | .. image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwxh06%2Fdockerjudge.svg?type=shield |
| | :alt: FOSSA Status |
| | :target: https://app.fossa.com/projects/git%2Bgithub.com%2Fwxh06%2Fdockerjudge |
+-----------------+-------------------------------------------------------------------------------------------------------+
| GitHub Actions | .. image:: https://github.com/wxh06/dockerjudge/workflows/Docker/badge.svg |
| | :alt: Docker |
| | :target: https://github.com/wxh06/dockerjudge/actions?query=workflow%3ADocker |
| +-------------------------------------------------------------------------------------------------------+
| | .. image:: https://github.com/wxh06/dockerjudge/workflows/Lint%20Code%20Base/badge.svg |
| | :alt: Lint Code Base |
| | :target: https://github.com/wxh06/dockerjudge/actions?query=workflow%3A%22Lint+Code+Base%22 |
| +-------------------------------------------------------------------------------------------------------+
| | .. image:: https://github.com/wxh06/dockerjudge/workflows/Python%20package/badge.svg |
| | :alt: Python package |
| | :target: https://github.com/wxh06/dockerjudge/actions?query=workflow%3A%22Python+package%22 |
| +-------------------------------------------------------------------------------------------------------+
| | .. image:: https://github.com/wxh06/dockerjudge/workflows/Transifex/badge.svg |
| | :alt: Trnsifex |
| | :target: https://github.com/wxh06/dockerjudge/actions?query=workflow%3ATransifex |
| +-------------------------------------------------------------------------------------------------------+
| | .. image:: https://github.com/wxh06/dockerjudge/workflows/Upload%20Python%20Package/badge.svg |
| | :alt: Upload Python Package |
| | :target: https://github.com/wxh06/dockerjudge/actions?query=workflow%3A%22Upload+Python+Package%22 |
+-----------------+-------------------------------------------------------------------------------------------------------+
| GitLab CI/CD | .. image:: https://gitlab.com/wangxinhe/dockerjudge/badges/master/pipeline.svg |
| | :alt: pipeline |
| | :target: https://gitlab.com/wangxinhe/dockerjudge/pipelines |
| +-------------------------------------------------------------------------------------------------------+
| | .. image:: https://gitlab.com/wangxinhe/dockerjudge/badges/master/coverage.svg |
| | :alt: coverage |
| | :target: https://gitlab.com/wangxinhe/dockerjudge/-/jobs |
+-----------------+-------------------------------------------------------------------------------------------------------+
| Read the Docs | .. image:: https://readthedocs.org/projects/dockerjudge/badge/ |
| | :alt: Documentation Status |
| | :target: https://readthedocs.org/projects/dockerjudge/builds/ |
+-----------------+-------------------------------------------------------------------------------------------------------+
| Travis CI | .. image:: https://travis-ci.com/wxh06/dockerjudge.svg |
| | :alt: Build Status |
| | :target: https://travis-ci.com/wxh06/dockerjudge |
| +-------------------------------------------------------------------------------------------------------+
| | .. image:: https://codecov.io/gh/wxh06/dockerjudge/branch/master/graph/badge.svg |
| | :alt: Codecov |
| | :target: https://codecov.io/gh/wxh06/dockerjudge |
+-----------------+-------------------------------------------------------------------------------------------------------+
Project links
=============
- `GitHub Repository <https://github.com/wxh06/dockerjudge>`_
- `GitLab Repository <https://gitlab.com/wangxinhe/dockerjudge>`_
- `PyPI Project <https://pypi.org/project/dockerjudge/>`_
- `Transifex Translation <https://www.transifex.com/piterator/dockerjudge/>`_
.. toctree::
:maxdepth: 2
:caption: Contents:
installation.rst
main.rst
processor.rst
status.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`