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

Better document the build #666

Merged
merged 37 commits into from Apr 19, 2018
Merged

Better document the build #666

merged 37 commits into from Apr 19, 2018

Conversation

jpmckinney
Copy link
Member

@jpmckinney jpmckinney commented Feb 1, 2018

Also, as far as I can tell, the building of .pot files is unnecessary to building the documentation (though it's necessary for collecting the source files that get pushed to Transifex). Is that correct?

I find build_docs.sh much easier to read now; the interdependency between commands is clear, and the script no longer requires jumping in and out of the standard directory.

@jpmckinney
Copy link
Member Author

jpmckinney commented Feb 6, 2018

Quite happy with this now. I can update the documentation in the handbook to use the Makefile, but now you can:

make clean # remove build directory and .mo files
make extract # generates .pot files
make push # generates .pot files then pushes to Transifex
make pull.es_MX # pull a specific translation
make pull # pull supported translations (es,fr)
make source # build the source language's docs
make es # build a specific translation's docs (as well as the source language's)
make # build supported translations' docs (as well as the source language's)

translate_codelists.py now uses the build directory and doesn't overwrite the same files in different languages (which could cause issues if commands were run out-of-order), instead writing the translated codelists to different language directories.

Note that you can use make -n to see the commands that would be run, without running them.

Copy link
Contributor

@Bjwebb Bjwebb left a comment

Choose a reason for hiding this comment

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

From a quick look through, this all seems to be good.

@jpmckinney
Copy link
Member Author

jpmckinney commented Feb 12, 2018

@jpmckinney jpmckinney changed the base branch from 1.1.3-dev to 1.1-dev March 7, 2018 18:26
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.

None yet

2 participants