Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Directive refactoring #698

Merged
merged 12 commits into from
Sep 2, 2021

Conversation

jakobandersen
Copy link
Collaborator

This should not change any behaviour (tested with Breathes own documentation).

Merge directive/ and directives.py into a directives/ module with the directives in separate files based on their types.

Note, the union directive is currently an "item" directive but should probably be changed to be a class-like directive so options like :members: become available. However, there is some strange namespacing rendering differences that needs to be ironed out first.

@vermeeren
Copy link
Collaborator

I will try to handle this PR tomorrow, it's too large for the current late-night round.

@jakobandersen jakobandersen force-pushed the directive_refactoring branch from b06df5b to 9e69659 Compare August 5, 2021 08:45
aprotyas pushed a commit to aprotyas/breathe that referenced this pull request Aug 19, 2021
Note, both of these PRs are on top of the changes introduced by
jakobandersen#698.

Links to PRs for future reference:
- breathe-doc#698
- breathe-doc#711
- breathe-doc#723

Signed-off-by: Abrar Rahman Protyasha <abrar@openrobotics.org>
aprotyas pushed a commit to aprotyas/breathe that referenced this pull request Aug 19, 2021
Note, both of these PRs are on top of the changes introduced by
upstream PR breathe-doc#698.

Links to PRs for future reference:
- breathe-doc#698
- breathe-doc#711
- breathe-doc#723

Signed-off-by: Abrar Rahman Protyasha <abrar@openrobotics.org>
@jakobandersen
Copy link
Collaborator Author

Once #721 has been merged I'll rebase this, #711, #723 to resolve conflicts and get the CI green.

@jakobandersen
Copy link
Collaborator Author

This should be ready for review now. It's quite a lot of changes, so reviewing each commit in turn may be the easiest.

Copy link
Collaborator

@michaeljones michaeljones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me and the output is the same.

I'm not used to leading underscores on classes but I can understand the motivation.

@michaeljones
Copy link
Collaborator

Merge when you're happy @jakobandersen :)

@jakobandersen jakobandersen merged commit 2347429 into breathe-doc:master Sep 2, 2021
@jakobandersen
Copy link
Collaborator Author

Thanks

@jakobandersen jakobandersen deleted the directive_refactoring branch September 2, 2021 06:37
@michaeljones
Copy link
Collaborator

🎉

michaeljones pushed a commit that referenced this pull request Sep 14, 2021
Also chronologically sort by moving the entry for #721.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants