.. raw:: html
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 ` should get
you up and running fairly quickly with a simple workflow. Dig deeper by reading about the :doc:`command line interface `, the
:doc:`recommended project layout `, the :doc:`workflow configuration file `, and
:doc:`details about the integration with LaTeX `.
|showyourwork| is an open source project hosted on `GitHub `__. It
is very much a work-in-progress, so please look over the `issues page `__
if you think you've spotted a bug, and feel free to `raise a new issue `__
if needed! Community contributions are also **most welcome**.
Contents
--------
.. toctree::
:maxdepth: 1
intro
install
quickstart
cli
layout
config
snakefile
action
latex
zenodo
overleaf
logging
migrating
reproducibility
faqs
contributorguide
api/showyourwork
changelog
attribution
projects