[docs] Improve apiDoc handling, add entry to Makefile, flourish #849
Conversation
This file contains 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
ix5
changed the title
ix5
added
client
This helps keep the root directory free of clutter and allows placing apiDoc templates etc. within one logical place.
apiDoc output will go into apidoc/_output/
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
A few minor changes to make the API docs easier to generate (and finally kind-of document the usage). Still needs more work, but this first draft can go in.
Final goal is to have apidocs generated alongside regular docs and uploaded to
/docs/api/latestor something similar.Edit: See
apiDocoutput live at isso-comments.github.io/docs/api/, GH Action with this commitgitignore: Ignore apiDoc output
apidoc: Add header and footer to apiDoc output
Makefile: Add apiDoc commands
apiDoc output will go into apidoc/_output/
apidoc.json: Move to subdirectory
This helps keep the root directory free of clutter and allows placing apiDoc templates etc. within one logical place.
apidoc.json: Add version, example URL, tab2spaces