Populate API reference #303
Merged
Merged
Conversation
The setup.py will scan the package’s sources for PEP 224-style docstrings under NamedTuple field annotations and writes a generated file with Cls.field.__doc__ assignments that we will include at the end. This is too allow documenting NamedTuple fields inline, which is otherwise not possible with our current setup.
Enum/class members needed to be documented manually because cython strips-away there doc strings.
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.
Copy API documentation from HarfBuzz and adapt it to Python code. Fights cython/autodoc a bit, but the end result seems good.