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
Pull requests
Logging
Custom workflows
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.conda_env
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
download
extract
pdf
preprocess
arxiv.smk
figure.smk
zenodo.smk
compile.smk
preprocess.smk
build.smk
prep.smk
Changelog
Projects that use showyourwork
repository
open issue
suggest edit
.rst
.pdf
compile.smk
compile.smk
#
Defines the rule
syw__compile
to build the article PDF.
