Introduction
Quickstart
Repository layout
The
showyourwork.yml
file
The
Snakefile
The showyourwork GitHub action
Local builds
Custom workflows
FAQs
Developer API
Changelog
Updating showyourwork
Projects that use showyourwork
repository
open issue
Index
A
|
C
|
D
|
E
|
F
|
I
|
M
|
P
|
R
|
S
|
T
|
U
|
Z
A
abspaths (class in rules.paths)
aux (rules.files.files attribute)
C
check_figure_format() (in module rules.functions)
class_files() (in module rules.functions)
cls (rules.files.files attribute)
D
deposit_contents (rules.zenodo.zenodo attribute)
deposit_creators (rules.zenodo.zenodo attribute)
deposit_description (rules.zenodo.zenodo attribute)
deposit_title (rules.zenodo.zenodo attribute)
dot_github (rules.paths.relpaths attribute)
dot_zenodo (rules.files.files attribute)
E
exception (rules.files.files attribute)
F
figure_script() (in module rules.functions)
figure_script_dependencies() (in module rules.functions)
figures (rules.paths.relpaths attribute)
figures() (in module rules.functions)
file_name (rules.zenodo.zenodo attribute)
file_path (rules.zenodo.zenodo attribute)
files (class in rules.files)
I
input_class_file() (in module rules.functions)
M
module
rules.config
rules.errors
rules.exceptions
rules.files
rules.functions
rules.paths
rules.zenodo
P
posix() (in module rules.paths)
R
relpaths (class in rules.paths)
rules.config
module
rules.errors
module
rules.exceptions
module
rules.files
module
rules.functions
module
rules.paths
module
rules.zenodo
module
S
sandbox (rules.zenodo.zenodo attribute)
script (rules.zenodo.zenodo attribute)
script_cmd() (in module rules.functions)
script_dependencies() (in module rules.functions)
script_extensions (rules.files.files attribute)
script_name() (in module rules.functions)
ScriptDoesNotExist (in module rules.errors)
ScriptHasUncommittedChanges (in module rules.errors)
ScriptNotVersionControlled (in module rules.errors)
ScriptUpToDate (in module rules.errors)
ShowyourworkException
special_figures (rules.files.files attribute)
T
tectonic (rules.files.files attribute)
temp (rules.paths.abspaths attribute)
(rules.paths.relpaths attribute)
tex (rules.paths.relpaths attribute)
tmp_syw (rules.files.files attribute)
tmp_xml (rules.files.files attribute)
token_name (rules.zenodo.zenodo attribute)
U
unknown (rules.files.files attribute)
user (rules.paths.abspaths attribute)
Z
zenodo (class in rules.zenodo)
zenodo_files_auto (rules.files.files attribute)
zenodo_files_manual (rules.files.files attribute)
zenodo_id (rules.zenodo.zenodo attribute)
zenodo_url (rules.zenodo.zenodo attribute)