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

programatically grab version for docs and live mode #116

Merged
merged 1 commit into from Apr 12, 2018

Conversation

Projects
None yet
3 participants
@jlmitch5
Copy link
Contributor

jlmitch5 commented Oct 14, 2017

This does a few things:

  • remove hardcoded references to version in both c code and docs md
  • updates module make command that gets git version to use the tag to grab the current semantic teletype version
  • updates live mode prompt to use the updated version string (same formatting--user won't notice any changes)
  • updates both docs (html/pdf) and cheatsheet to include version in the title.

I didn't run clang, but the c changes are so small I can't imagine a formatting issue snuck in.

I conformed to pep8 using flake8 for all the python code. @samdoshi There seems to be a few f"..." strings that were getting picked up as invalid syntax from running flake8 on the commandline as well as with the atom package I downloaded...I didn't edit them, didn't see any error output when running the docs make commands, and couldn't not figure out what it thought was invalid about the syntax. Let me know if there's something I can do to get those to go away.

I'm mostly happy with the code, but the makefile gitversion.c command is really long, and I am not bash-savvy enough to figure how to cleanly break up into multiple lines. If anyone has any suggestions there, paste what it should be and I'll gladly change it!


What it looks like on HTML docs:

screen shot 2017-10-13 at 8 05 51 pm

On pdf docs:

screen shot 2017-10-13 at 8 06 05 pm

screen shot 2017-10-13 at 8 06 11 pm

On pdf cheatsheet:

screen shot 2017-10-13 at 8 07 58 pm

Running on teletype:

img_1670

@jlmitch5

This comment has been minimized.

Copy link
Contributor Author

jlmitch5 commented Oct 14, 2017

@tehn if you wouldn't mind waiting to merge until @samdoshi has a chance to checkout the python stuff I'd appreciate it...he had some suggestions via PM that I want to make sure I did like he wanted.

@samdoshi

This comment has been minimized.

Copy link
Collaborator

samdoshi commented Oct 14, 2017

Looks good to me.

The only thing I would tweak is the string VERSION to something more obviously a template variable (e.g. $VERSION$).

If it's okay I'm going to make a few tweaks to the PDF versions once this merges (I might have an experiment with headers and footers). I can make the VERSION change at the same time or you can in this PR. I'm easy. Let me know.

@jlmitch5

This comment has been minimized.

Copy link
Contributor Author

jlmitch5 commented Oct 14, 2017

@samdoshi done! (sorry about the two commits...did this from the web editor).

If this looks good to everyone else/you @tehn, feel free to merge.

@jlmitch5

This comment has been minimized.

Copy link
Contributor Author

jlmitch5 commented Oct 15, 2017

Let's leave this be until we figure out the 2.1.0 squashing stuff. I can rebase if need be.

@samdoshi

This comment has been minimized.

Copy link
Collaborator

samdoshi commented Oct 18, 2017

If you wanted to rebase this and force push, that would be welcome. Just to stop the network graph looking quite so bonkers.

If not, it doesn't really matter, just let me know either way.

@jlmitch5

This comment has been minimized.

Copy link
Contributor Author

jlmitch5 commented Oct 18, 2017

@jlmitch5 jlmitch5 force-pushed the jlmitch5:docsVersion branch from d8c07dd to 5f4d7c1 Oct 20, 2017

@jlmitch5

This comment has been minimized.

Copy link
Contributor Author

jlmitch5 commented Oct 20, 2017

@samdoshi whoops--forgot about this. I just rebased so this should be ready to go. @samdoshi @tehn I think this is good to merge.

@samdoshi

This comment has been minimized.

Copy link
Collaborator

samdoshi commented Oct 21, 2017

Looks like you lost the $VERSION$ change you made...

If you don't get a chance, I'll merge it on Monday and submit a PR to tweak it and a few other docs related changes I want to make late in the week.

@tehn

This comment has been minimized.

Copy link
Member

tehn commented Dec 19, 2017

ok looks like this is going to need rebasing against the 2.2 which i just merged. i apologize for the delay, should've gotten this in sooner.

@tehn

This comment has been minimized.

Copy link
Member

tehn commented Dec 19, 2017

that said, it's a pretty minor conflict.

@jlmitch5

This comment has been minimized.

Copy link
Contributor Author

jlmitch5 commented Dec 19, 2017

@tehn happy to rebase agains 2.2 sometime this week, thanks for following up on this.

@jlmitch5 jlmitch5 force-pushed the jlmitch5:docsVersion branch 2 times, most recently from 92fe6e9 to e9ba6fb Apr 11, 2018

@jlmitch5 jlmitch5 force-pushed the jlmitch5:docsVersion branch from e9ba6fb to b7320ae Apr 11, 2018

@tehn

tehn approved these changes Apr 12, 2018

@tehn tehn merged commit 4e007c5 into monome:master Apr 12, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.