Toggle navigation sidebar
Toggle in-page Table of Contents
Introduction
Installation
Quickstart
Command line interface
Repository layout
The showyourwork.yml config file
The Snakefile
The GitHub action
LaTeX stuff
Zenodo integration
Overleaf integration
Logging
Migrating from previous versions
FAQs
Developer API
cli
cli.commands
cli.commands.build
cli.commands.cache
cli.commands.clean
cli.commands.preprocess
cli.commands.setup
cli.commands.tarball
cli.commands.zenodo
cli.main
exceptions
exceptions.base
exceptions.github
exceptions.latex
exceptions.other
exceptions.overleaf
exceptions.zenodo
config
git
gitapi
logging
overleaf
patches
paths
subproc
tex
userrules
zenodo
arxiv
conda
download
extract
pdf
preprocess
render_dag
arxiv.smk
figure.smk
render_dag.smk
zenodo.smk
compile.smk
conda.smk
dag.smk
preprocess.smk
build.smk
prep.smk
Integration tests
Changelog
Attribution
Projects that use showyourwork
repository
open issue
suggest edit
.rst
.pdf
cli.commands
cli.commands
#
Implements all the subcommands of the
showyourwork
command line tool.
cli.commands.build
cli.commands.cache
cli.commands.clean
cli.commands.preprocess
cli.commands.setup
cli.commands.tarball
cli.commands.zenodo
