Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update environment and documentation #81

Merged
merged 2 commits into from
Nov 1, 2017

Conversation

dhimmel
Copy link
Member

@dhimmel dhimmel commented Oct 31, 2017

Pandoc upgraded to v2.0.0.1.

Swap anaconda packages to conda-forge.

Pandoc upgraded to v2.0.0.1
@dhimmel dhimmel force-pushed the update-env-2017-10-31 branch from 24be208 to 46577a2 Compare October 31, 2017 18:48
WeasyPrint was not renderring MathJax, so use --webtex to convert
equations to SVGs for PDF  output. See
Kozea/WeasyPrint#59
@dhimmel dhimmel merged commit ec186c2 into manubot:master Nov 1, 2017
@dhimmel dhimmel deleted the update-env-2017-10-31 branch November 1, 2017 16:46
dhimmel added a commit that referenced this pull request Nov 1, 2017
This build is based on
ec186c2.

This commit was created by the following Travis CI build and job:
https://travis-ci.org/greenelab/manubot-rootstock/builds/295841617
https://travis-ci.org/greenelab/manubot-rootstock/jobs/295841618

[ci skip]

The full commit message that triggered this build is copied below:

Update environment and documentation (#81)

Pandoc upgraded to v2.0.0.1

Swap anaconda packages to conda-forge

Update build.sh for pandoc 2.0

WeasyPrint was not renderring MathJax, so use --webtex to convert
equations to SVGs for PDF output. See
Kozea/WeasyPrint#59
dhimmel added a commit that referenced this pull request Nov 1, 2017
This build is based on
ec186c2.

This commit was created by the following Travis CI build and job:
https://travis-ci.org/greenelab/manubot-rootstock/builds/295841617
https://travis-ci.org/greenelab/manubot-rootstock/jobs/295841618

[ci skip]

The full commit message that triggered this build is copied below:

Update environment and documentation (#81)

Pandoc upgraded to v2.0.0.1

Swap anaconda packages to conda-forge

Update build.sh for pandoc 2.0

WeasyPrint was not renderring MathJax, so use --webtex to convert
equations to SVGs for PDF output. See
Kozea/WeasyPrint#59
@@ -120,7 +120,7 @@ For guidance on what CSL JSON should be like for different document types, refer
## Manuscript metadata

[`content/metadata.yaml`](content/metadata.yaml) contains manuscript metadata that gets passed through to Pandoc, via a [`yaml_metadata_block`](http://pandoc.org/MANUAL.html#extension-yaml_metadata_block).
`metadata.yaml` should contain the manuscript `title`, `authors` list, and `keywords`.
`metadata.yaml` should contain the manuscript `title`, `authors` list, `keywords`, and language (`lang`).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dhimmel can we link to a list of valid language codes?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From Pandoc docs:

lang: identifies the main language of the document, using a code according to BCP 47 (e.g. en or en-GB). For some output formats, pandoc will convert it to an appropriate format stored in the additional variables babel-lang, polyglossia-lang (LaTeX) and context-lang (ConTeXt).

I will look for a BCP 47 list of language codes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BCP 47 codes can combine a language and region. Language codes are defined here. Region codes are here.

These BCP 47 codes can get quite complex it seems as they can have the following parts:

language-extlang-script-region-variant-extension-privateuse

There's an unofficial validator at http://schneegans.de/lv/ that may be helpful. Wonder how complicated we want to make these docs!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great info. Linking to one or two of those resources could help users without adding much more complexity to these manubot docs.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix proposed in #83

@agitter
Copy link
Member

agitter commented Nov 1, 2017

Swap anaconda packages to conda-forge.

As a general Python question, why do you prefer conda-forge over anaconda? Does it provide more flexibility or more frequent updates because it is community-driven?

@dhimmel
Copy link
Member Author

dhimmel commented Nov 1, 2017

conda-forge is an open system, whereas the anaconda recipes to build packages are not public (see comment here). In the past, anaconda had greater package coverage, but lately I think conda-forge now has better coverage and generally is updated with new versions more quickly.

In addition, if conda-forge is outdated, you can update it yourself, like I did in conda-forge/pandoc-feedstock#19. Previously, we were only using conda-forge for packages that weren't available in anaconda. However, once I experienced an error from using an R binary from the anaconda R channel and an R package from conda-forge. So I think it's ideal to rely on a single channel for all packages if possible. Now conda-forge seems to be mature enough to support this.

@agitter
Copy link
Member

agitter commented Nov 1, 2017

conda-forge is an open system..

Thanks, that's a very helpful explanation. I now recall a blog post that described what you noted about mixing channels. On a related note, the Anaconda 5.0 release notes state

Where possible, all build recipes are now using conda-forge as a base, via https://github.com/AnacondaRecipes.

dhimmel added a commit to dhimmel/manubot-rootstock that referenced this pull request Nov 1, 2017
dhimmel added a commit to dhimmel/manubot-rootstock that referenced this pull request Nov 1, 2017
dhimmel added a commit that referenced this pull request Nov 2, 2017
This build is based on
46824e6.

This commit was created by the following Travis CI build and job:
https://travis-ci.org/greenelab/manubot-rootstock/builds/296253421
https://travis-ci.org/greenelab/manubot-rootstock/jobs/296253422

[ci skip]

The full commit message that triggered this build is copied below:

USAGE.md: link to language tag documentation (#83)

#81 (comment)
dhimmel added a commit that referenced this pull request Nov 2, 2017
This build is based on
46824e6.

This commit was created by the following Travis CI build and job:
https://travis-ci.org/greenelab/manubot-rootstock/builds/296253421
https://travis-ci.org/greenelab/manubot-rootstock/jobs/296253422

[ci skip]

The full commit message that triggered this build is copied below:

USAGE.md: link to language tag documentation (#83)

#81 (comment)
adebali pushed a commit to CompGenomeLab/lemur-manuscript-archive that referenced this pull request Mar 4, 2020
ploegieku added a commit to ploegieku/2023-functional-homology-paper that referenced this pull request Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants