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

support for MD block quotes with attribution(s) #759

Merged
merged 1 commit into from
Feb 14, 2022
Merged

support for MD block quotes with attribution(s) #759

merged 1 commit into from
Feb 14, 2022

Conversation

2bndy5
Copy link
Contributor

@2bndy5 2bndy5 commented Nov 8, 2021

resolves #758

See issue thread for more details (includes XML, HTML, and MD snippets).

@vermeeren vermeeren self-assigned this Feb 14, 2022
@vermeeren vermeeren added code Source code enhancement Improvements, additions (also cosmetics) labels Feb 14, 2022
Copy link
Collaborator

@vermeeren vermeeren left a comment

Choose a reason for hiding this comment

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

@2bndy5 Thanks for all your patches recently! This one was the final non-WIP PR in queue, glad to have caught up with it all today. Will do my best to respond quick to coming patches.

michaeljones pushed a commit that referenced this pull request Feb 14, 2022
@michaeljones michaeljones merged commit f196631 into breathe-doc:master Feb 14, 2022
@2bndy5 2bndy5 deleted the support-blockquotes branch February 14, 2022 02:41
@2bndy5
Copy link
Contributor Author

2bndy5 commented Feb 14, 2022

Just wanted to voice my gratitude for all the work done today. @vermeeren You went above and beyond my expectations concerning git history and merge conflicts! Sorry, I wasn't more responsive during this streak of productivity (I was sleeping).

Given that there is only 1 PR at this time, I think I'll start work on a submission that will reduce the warnings/errors in the docs build logs. @michaeljones I noticed there's a new project logo being used. Any objections to using that branding for the docs' favicon (instead of RTD's default)? I can't decide if this pursuit is worthy of an issue or a discussion (kinda leaning toward a new issue).

@vermeeren
Copy link
Collaborator

@2bndy5 Thanks for the feedback! Perfectly fine to submit PRs as you see, also for the logo. No need for issue imo as it's kinda an obvious improvement.

Cheers

@michaeljones
Copy link
Collaborator

Thanks for picking up on the favicon thing @2bndy5. Sounds good to me!

@2bndy5
Copy link
Contributor Author

2bndy5 commented Feb 23, 2022

@michaeljones Can I interest you in switching to the furo theme? It supports light/dark/system schemes out of the box and displays the ToC in an independent menu. I discovered it when reading the docs for pip, setuptools, and sphinx_design.

The PR about dealing warnings/errors from sphinx and doxygen is almost ready. Though, if we use furo theme, then the .. contents:: directive is useless/redundant.
image

@michaeljones
Copy link
Collaborator

I think I'd be happy moving to that. I'd like to try to unify the visuals around the different parts of Breathe. Mostly using the logo and maybe trying to align colours between the docs and the website a little. The website colours aren't final though so we can adjust those.

Are you happy to provide a PR with that change?

@2bndy5
Copy link
Contributor Author

2bndy5 commented Feb 25, 2022

I'm about to submit a PR with the theme change, pygments typing, and enable -W option for sphinx-build command (I fixed 400+ warnings in the doc build log).

I would've suggested the sphinx-immaterial them (which I help maintain), but there's a CSS problem with displaying C/C++ domain signatures.

As far as the colors for the website, is the code hosted somewhere? I'd like to propose a CSS change that compensates for light & dark theme (via media query). If viewed with the dark reader extension enabled, then the current website's text has a 💩 brown background.

@michaeljones
Copy link
Collaborator

It is hosted on a server I run and the code is in another repo. I guess we could consider moving the website code here to start opening up avenues for improvement. Or I can invite you to the other repo. Not sure of the pros & cons. I'll start with the latter and we'll see.

This was referenced Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code Source code enhancement Improvements, additions (also cosmetics)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[request] support block quotes
3 participants