Documentation in Sphinx #8
Merged
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
…arted, ror, requirements and setup pages. Edited a bunch of other existing pages.
…ome other parts of the API such as the Renderer class.
…es. Added a Jinja2 Templates section to showcase how the templates actually work with pyLDAPI and what variables they require.
|
@edmondchuc Should some or all of these changes be merged into master? |
|
@ashleysommer The docs are currently on the 'docs' branch since I was testing documentation deployment to Read the Docs. Once I double check that I have made no functional changes, I will make a pull request to master branch. I've changed I also drafted a possible solution to the Renderer class here: #9 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Most of the changes in the source code non-functional such as changes in the docstrings, etc.
There is one functional change in
pyldapi.Renderer._render_alternates_view(). It has been changed topyldapi.Renderer.render_alternates_view(). If this gets accepted, then we will also need to addpyldapi.Renderer._render_alternates_view()back in to not break existing projects.The reason for the change is, "I will be looking into refactoring parts of the pyLDAPI – more specifically the current requirement of using pyldapi.Renderer._render_alternates_view() for custom Renderer classes. If it’s required to be called manually, it should ideally drop the prefix underscore. Otherwise see if it’s possible to refactor it to the behaviour of the RegisterRenderer class where it’s handled automatically by the tool (I think unlikely after having some time thinking about it)."