docs: Move BuildElement's "Built-in functionality" to a new page#2122
Open
docs: Move BuildElement's "Built-in functionality" to a new page#2122
Conversation
The documentation of how to use the common features provided by the `BuildElement` base class is currently part of the API reference even though it's more relevant to project authors than plugin developers. This moves that section to a new page in the "Reference" section, next to other plugin-specific documentation. Co-authored-by: Dom Rodriguez <dom.rodriguez@codethink.co.uk>
juergbi
requested review from
BenjaminSchubert,
abderrahim,
cs-shadow and
gtristan
as code owners
Contributor
Author
|
From #2103 (review) (@tmewett):
I've linked the new page as "Build Elements" in the TOC and tried to make the intro paragraph a bit more understandable for project authors. If you have any suggestions how to further improve that, please let me know. |
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.
The documentation of how to use the common features provided by the
BuildElementbase class is currently part of the API reference even though it's more relevant to project authors than plugin developers.This moves that section to a new page in the "Reference" section, next to other plugin-specific documentation.
The main content of the new page is unchanged but I've tweaked the initial paragraphs to make sense with the structure change.
This is a replacement for #2103 with proper links and TOC entry (a bit quirky with Sphinx but I think it looks and works reasonably well now).