Skip to content

Conversation

@NathanSpeidel
Copy link
Member

No description provided.


`make serve` will serve the documentation so it can be viewed from a local browser.

`make release` will build a release and commit it to your local "master" branch. This command assumes you have a clean git environment ("git diff" prints nothing). It will build the documentation and commit it to your local master branch. **YOU must push the changes** in your master branch to the remote repo if you want to publish the changes after the command completes successfully.
Copy link
Member

Choose a reason for hiding this comment

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

It no longer commits

Copy link
Member Author

Choose a reason for hiding this comment

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

It does commit - just no longer pushes.

bin/release.sh Outdated
git checkout master
git pull
# Carefully delete everything in this folder
rm -rf ../bullet-db.github.io/*
Copy link
Member

Choose a reason for hiding this comment

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

It doesn't have to be called this (mine is called bullet-docs, for ex). * should be fine because you did all these git and mkdocs commands that wouldn't have worked otherwise

@NathanSpeidel NathanSpeidel merged commit a336eb0 into src Jul 27, 2018
@NathanSpeidel NathanSpeidel deleted the add-makefile branch July 27, 2018 19:39
@hbxie hbxie mentioned this pull request Jul 27, 2018
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.

4 participants