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

Adds a man page #556

Merged
merged 3 commits into from
Feb 10, 2020
Merged

Adds a man page #556

merged 3 commits into from
Feb 10, 2020

Conversation

atheriel
Copy link
Collaborator

@atheriel atheriel commented Feb 8, 2020

The final man page is currently generated from the blocks.md and themes.md files, plus a custom preface and postface. You can run man/generate.sh to regenerate the man page after changes to those files.

I have also added a check to Travis CI that will fail if a commit updates the block/theme documentation but does not regenerate the man page in this way, which we should probably document somewhere.

This should close #380 and supersedes #391.

@atheriel atheriel added enhancement docs Documentation errors, updates, or omissions. labels Feb 8, 2020
The check does not yet fail the build because different versions of
pandoc produce slightly different output.
@atheriel
Copy link
Collaborator Author

Unfortunately it turns out that different versions of pandoc produce slightly different output, so this can't be an actual check failing the build just yet.

@atheriel atheriel merged commit a866c59 into master Feb 10, 2020
@atheriel atheriel deleted the manpage branch February 10, 2020 17:14
ammgws added a commit that referenced this pull request Dec 2, 2020
Turns out this test was meaningless since it has been passing this whole time even though the manpage was VERY outdated. Relevant: #556 (comment)
GladOSkar pushed a commit to GladOSkar/i3status-rust that referenced this pull request Dec 16, 2020
Turns out this test was meaningless since it has been passing this whole time even though the manpage was VERY outdated. Relevant: greshake#556 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation errors, updates, or omissions. enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Man page
1 participant