v0.4.3

What's Changed

• No arguments will give help information by @arm61 in #272
• Protected the \nolinenumbers command by @eelsirhc in #251
• Fixed build warnings by @dfm in #275
• Fixing #278 by adding explicit dependencies on static figures by @dfm in #279
• Splitting monolithic rules to enable finer-grain control of tasks by @dfm in #266
• Remove rogue space after \variable by @arm61 in #288
• test python 3.8, 3.10, Windows, and MacOS by @sgbaird in #300
• Add note about ancient() and ignoring timestamps by @adrn in #305
• doc: showyourwork build now required instead of showyourwork by @lgarrison in #313
• Some additions to intro re Snakemake by @maxisi in #311
• Enable and document monochrome and custom color margin icons by @arm61 in #308
• Snakemake howto by @katiebreivik in #310
• Adding a "Debugging" section to FAQ describing conda envs by @rwegener2 in #309
• Updated version of tectonic by @dfm in #320
• Fix regex for overleaf setup by @mileslucas in #327
• Add instructions about using mamba by @HealthyPear in #333
• Using new Overleaf project for remote tests by @dfm in #335
• Add section to docs describing how to setup docs env by @rwegener2 in #319
• Allow horizontal moving of margin icons by @arm61 in #324
• Allow user-defined tectonic.yml by @MilesCranmer in #351
• Fix missing tectonic args by @MilesCranmer in #350
• Enable custom root directory of build commands by @MilesCranmer in #348
• Fix a few typos in docs by @pitmonticone in #355
• Changing build dependency constraints to fix release build by @dfm in #357
• Fix bug in showyourwork clean --deep by @wtbarnes in #363
• Fixing bug in cwd_as by @dfm in #366
• Try installing tectonic with brew on mac by @dfm in #367
• Fix invalid escape character warning by @dfm in #369
• Recommend the user use shell-escape-cwd by @MilesCranmer in #365
• New overview figure by @MilesCranmer in #354
• Delete .bib files for tarball by @MilesCranmer in #370
• Enabling merge queue by @dfm in #371
• Update projects.json by @arm61 in #378
• Switch to using micromamba on CI instead of setup-miniconda by @dfm in #381
• I can't seem to consistently get mac tests working so, I'll just disable them because it's a headache :( by @dfm in #384
• Adding test for synctex generation and fixing file paths by @dfm in #372
• Enable preprocessing of arXiv submission contents by @MilesCranmer in #364

New Contributors

• @eelsirhc made their first contribution in #251
• @sgbaird made their first contribution in #300
• @lgarrison made their first contribution in #313
• @maxisi made their first contribution in #311
• @rwegener2 made their first contribution in #309
• @mileslucas made their first contribution in #327
• @HealthyPear made their first contribution in #333
• @pitmonticone made their first contribution in #355
• @wtbarnes made their first contribution in #363

Full Changelog: v0.4.2...v0.4.3

v0.4.3rc3

Enable preprocessing of arXiv submission contents (#364)

* Enable preprocessing arXiv submission contents

* Document `preprocess_arxiv`

* Use copytree instead of copy

* Fix Path conversion

* Only copy upon preprocess

* Reduce preprocess option to a single param

* Rearrange cookiecutter comment

v0.4.3rc2

Release candidate for v0.4.3

v0.4.3rc1

A release candidate for v0.4.3

v0.4.2

What's Changed

• Define \variable as \input in placeholder sty file by @rodluger in #235
• Fix Illegal parameter error in minimal showyourwork.sty by @MilesCranmer in #244
• Updating the zenodo docs to detail how to access cached directories by @LouisDesdoigts in #248
• Escape paths in all subprocess calls to handle spaces by @dfm in #259
• Update project using showyourwork by @arm61 in #255
• add example paragraph for reproducibility by @mathren in #256
• Deprecating current support of showyourwork command line with arguments and no subcommand by @dfm in #267
• Exposing multicore execution and mamba frontend by passing arguments to snakemake by @dfm in #268
• Updated the text of the CLI warning by @dfm in #273
• Protected the \nolinenumbers command by @eelsirhc in #251
• Fixed build warnings (#275) by @dfm in #276

New Contributors

• @LouisDesdoigts made their first contribution in #248
• @eelsirhc made their first contribution in #251

Full Changelog: v0.4.1...v0.4.2

v0.4.2rc2

A second release candidate for v0.4.2

v0.4.2rc1

Release candidate for v0.4.2

v0.4.1

Release notes

• Fixed string.removeprefix compatibility issue for Python 3.8.
• Upgraded click dependency to fix compatibility issue with decorators; added explicit dep on packaging package.
• Fixed issue with Zenodo latency when no $SANDBOX_TOKEN env variable defined.
• Fixed issue with conda channel priorities and UnsatisfiableError exceptions.
• Added support for SyncTeX.
• Added option to ignore certain files when rendering the article DAG.
• Added entries to the FAQs and cleaned up the docs a bit.

What's Changed

• Fmt fix by @rodluger in #226
• Ignore patterns for dag by @rodluger in #228
• copy synctex file over by @rodluger in #230
• channel priority fix by @rodluger in #233

Full Changelog: v0.4.0...v0.4.1

v0.4.0

Release Notes

• Major update to the versioning system for showyourwork articles, and to how dependencies are managed. As of this version, showyourwork no longer manages its own conda environment -- this led to various issues such as inconsistencies in the environment when the version of showyourwork used to launch the workflow differed from the version specified in the workflow.
• Related to the change above, we no longer require workflows to be executed with the same version of showyourwork that created them. From now on, workflows will be executed with whatever version of showyourwork is installed in the current environment (provided it is >=0.4.0). We are committed to make sure changes to the code are backwards compatible, so the latest version of showyourwork will be able to execute any workflow created with a previous version. This makes it much easier to maintain the workflow, since any issues with the code or any of its dependencies can be resolved by simply upgrading the locally installed version (as opposed to having to patch all previous versions, for example here).
• The version setting in showyourwork.yml is no longer used (see above); we recommend still including it, however, for bookkeeping purposes.
• For extended discussions about the above points, please see this issue and the comments in this PR and this PR.
• showyourwork no longer has explicit non-python dependencies; packages like tectonic are specified within conda environments to specific rules, so non-python dependency management is relagated to snakemake.
• Now enforcing strict channel provenance in environment.yml files.
• Upgraded the pinned version of Snakemake to 7.15.2, which fixes several bugs and adds new features (such as this one).
• Removes showyourwork logo and abstract margin icon in favor of a showyourwork stamp in the upper right hand corner of the first page of the article. This approach is class-independent and fixes several issues with specific classes (such as "Float(s) lost" errors with MNRAS and ARA&A). The positioning and style of the stamp is configurable in showyourwork.yml.
• Check if figure, abstract defined before redefining them; allows usage of showyourwork with document classes such as article, which don't define an abstract environment.
• Added GitHub margin links for \variable{} commands.
• The repository template now includes all available options (set to their default values) in the showyourwork.yml config file.
• The preprocessing step is now automatically re-run when zenodo.yml changes.
• Miscellaneous bug fixes, docs improvements, and deprecation warning fixes.

What's Changed

• Fixing deprecated control sequence warning by @dfm in #175
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #179
• Fixing latex error for ARA&A class by @dfm in #177
• Check if figure, abstract defined before redefining them by @rodluger in #183
• CLI error message tweaks by @MilesCranmer in #185
• Auto remove safe to test by @rodluger in #190
• Watermark version of showyourwork logo and GitHub Icons by @rodluger in #184
• bugfix in log message by @rodluger in #193
• Remove aastex tweak by @rodluger in #194
• Margin links for variables by @rodluger in #196
• Allow users to disable cache by @rodluger in #204
• Matrix strategy for workflow versions by @rodluger in #205
• control syw action spec in setup by @rodluger in #209
• Matrix strategy for workflow versions by @rodluger in #206
• Re-run preprocessing step when zenodo.yml changes by @rodluger in #211
• Consistent environments & Snakemake upgrade by @rodluger in #212
• Multiple staging branches by @rodluger in #218
• Add option to not commit overleaf changes by @rodluger in #189
• Test against 0.3.1.post1 by @rodluger in #219
• Test 0.3.1.post1 by @rodluger in #220
• Fix envs by @rodluger in #217
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #223
• Better approach to showyourwork envs and deps by @rodluger in #221

Full Changelog: v0.3.1...v0.4.0

v0.3.1.post1

Pins tabulate==0.8.10 to patch an issue with Snakemake (#215) that was breaking all builds for showyourwork==0.3.1.