.. raw:: html

   <div align="center">
   <img src="_static/logo.png" width="450px">
   </img>
   <br/>
   </div>
   <style>
      h1 {
         visibility: hidden;
         height: 0px;
      }
   </style>

Documentation
=============

Welcome to |showyourwork|, a workflow management tool for open source scientific articles.
If you want to make your research article **reproducible**, **extensible**, **transparent**, or just
downright **awesome**, you've found the right tool. |showyourwork| automates your entire workflow,
packaging it into a self-contained recipe that anyone can follow and---at the click of a button---use
to reproduce your results.

.. include:: quickbuild.rst

Check out the pages below for more information about this project. The :doc:`quickstart tutorial <quickstart>` should get
you up and running fairly quickly with a simple workflow. Dig deeper by reading about the :doc:`command line interface <cli>`, the
:doc:`recommended project layout <layout>`, the :doc:`workflow configuration file <config>`, and
:doc:`details about the integration with LaTeX <latex>`.

|showyourwork| is an open source project hosted on `GitHub <https://github.com/showyourwork/showyourwork>`__. It
is very much a work-in-progress, so please look over the `issues page <https://github.com/showyourwork/showyourwork/issues>`__
if you think you've spotted a bug, and feel free to `raise a new issue <https://github.com/showyourwork/showyourwork/issues/new>`__
if needed! Community contributions are also **most welcome**.


Contents
--------

.. toctree::
   :maxdepth: 1

   intro
   install
   quickstart
   cli
   templates
   layout
   config
   snakefile
   action
   latex
   zenodo
   overleaf
   logging
   migrating
   reproducibility
   known_issues
   faqs
   contributorguide
   api/showyourwork
   changelog
   attribution
   projects