Introduction
Quickstart
Repository layout
The
showyourwork.yml
file
The
Snakefile
The showyourwork GitHub action
LaTeX stuff
Local builds
Custom workflows
FAQs
Developer API
Changelog
Updating showyourwork
Projects that use showyourwork
repository
open issue
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
W
|
Z
A
abspaths (class in rules.paths)
aux (rules.files.files attribute)
C
check_citation() (helpers.linter.lint method)
check_figure_format() (in module rules.functions)
check_readme() (helpers.linter.lint method)
check_status() (in module helpers.zenodo)
check_tree() (helpers.linter.lint method)
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_id (rules.zenodo.zenodo attribute)
deposit_id_type (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)
figures (rules.paths.relpaths attribute)
figures() (in module rules.functions)
File (class in rules.functions)
file_name (rules.zenodo.zenodo attribute)
file_path (rules.zenodo.zenodo attribute)
files (class in rules.files)
G
get_access_token() (in module helpers.zenodo)
get_id_type() (in module helpers.zenodo)
get_repo_branch() (in module rules.git)
get_repo_sha() (in module rules.git)
get_repo_url() (in module rules.git)
get_script_status() (in module rules.git)
H
helpers (rules.paths.abspaths attribute)
helpers.exceptions
module
helpers.linter
module
helpers.zenodo
module
I
input_class_file() (in module rules.functions)
L
lint (class in helpers.linter)
M
module
helpers.exceptions
helpers.linter
helpers.zenodo
rules.config
rules.errors
rules.files
rules.functions
rules.git
rules.paths
rules.zenodo
N
no_traceback() (in module helpers.zenodo)
no_traceback_excepthook() (in module helpers.zenodo)
P
posix() (in module rules.paths)
print() (helpers.exceptions.ShowyourworkException static method)
(helpers.exceptions.ShowyourworkWarning static method)
R
relpaths (class in rules.paths)
remove_bad_dotzenodo_files() (in module helpers.zenodo)
reserve() (in module helpers.zenodo)
rules.config
module
rules.errors
module
rules.files
module
rules.functions
module
rules.git
module
rules.paths
module
rules.zenodo
module
S
script (rules.zenodo.zenodo attribute)
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)
shell_cmd() (in module rules.functions)
ShowyourworkException
ShowyourworkWarning (class in helpers.exceptions)
special_figures (rules.files.files attribute)
T
tectonic (rules.files.files attribute)
temp (rules.paths.abspaths attribute)
(rules.paths.relpaths attribute)
temp_rules (rules.paths.abspaths attribute)
temp_zenodo (rules.paths.abspaths 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)
W
warning (rules.files.files attribute)
Z
zenodo (class in rules.zenodo)
zenodo_files_auto (rules.files.files attribute)
zenodo_files_manual (rules.files.files attribute)
zenodo_url (rules.zenodo.zenodo attribute)