Repository navigation
Add C# objects to the general index - #21
Merged
Merged
Conversation
Each object gets an entry such as "MyNamespace.MyClass (C# class)". The :no-index-entry: option leaves an object out.
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.
C# objects never appeared in the general index.
get_index_textwas copied from Sphinx's rst domain and only produced text for thedirectiveandroleobject types, which thecsdomain does not have.Each object now gets an entry such as
MyNamespace.MyClass (C# class), using the object type names fromCSharpDomain.object_types. The standard:no-index-entry:option leaves an object out.inheritsadds no entry, since it describes a base type and not a declaration.This changes HTML output: projects with a general index, including Breathe-generated APIs, gain one entry per documented object.