Misc documentation improvements#213
Open
embray wants to merge 9 commits into
Open
Conversation
Add more ReST headings within the source headers so that the API docs are better organized within the ToC.
This consolidates previously scattered information about compression handling into a single page; much better.
Fill in a bit more missing docstrings. asdf-formatgh-202
Set Sphinx up to generate a man page from it (manually mantaining a man page in roff is pure pain). The generated page is checked into the repository, however, so that it can easily be included in release tarballs. This means has to be manually re-generated when updating the CLI docs which, fortunately, shouldn't happen that often. Shame there's not also some way I could automatically extract this page directly from the code. Of course it could be done with a custom Sphinx extension, but not worth the effort. asdf-formatgh-202
Caught while looking at the code to write the CLI documentation.
embray
force-pushed
the
issue-202
branch
4 times, most recently
from
75d2fdf to
65f36c4
Compare
Same as in the autotools build, but was previously omitted. Mention the flag in the readme.
Since some versions of Apple's SDK now seem to include sys/endian.h check for that first. Still, don't redefine endianness macros if they are already defined, but the configure checks somehow failed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #202 with everything discussed there and more:
asdftool which wasn't previously mentioned anywhere