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

Docs: Add links to documentation on creating custom classes #8466

Merged
merged 2 commits into from
Mar 2, 2022

Conversation

nienn
Copy link
Contributor

@nienn nienn commented Sep 6, 2021

WIP

I know there might be more than one way to add a custom class, depending on several factors, but it would be useful to add here some reference to where such information could be found.


.. seealso::

You can also add custom classes to your html elements. See `Docutils Class <https://docutils.sourceforge.io/docs/ref/rst/directives.html#class>`_ and this related `Sphinx footnote... <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#id2>`_ for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

Good catch! This was painfully difficult to find on the Sphinx docs, I will send a pull request there right now.

I think this information is too important to be in a seealso admonition! What about expanding it into its own subsection and adding a small example?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding its own subsection sounds great. This is information that most people trying to add a custom CSS file will be looking for, so it makes sense to me to expand on it. Also, the information available today on the combined related docs is scarce and insufficient.

This seealso could become just a link to that new subsection.

@astrojuanlu
Copy link
Contributor

By the way, I opened sphinx-doc/sphinx#9615 in Sphinx.

@stale
Copy link

stale bot commented Mar 2, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Mar 2, 2022
@humitos
Copy link
Member

humitos commented Mar 2, 2022

It seems this change looks good. However, it was blocked on writing a new section for it. @nienn do you think you will have the time to write that section or should we merge what we currently have as it is? In that case, can you solve the conflicts?

@stale stale bot removed the Status: stale Issue will be considered inactive soon label Mar 2, 2022
@nienn nienn force-pushed the nienn/docs-link-custom-class branch from 3ac354e to 24405b3 Compare March 2, 2022 14:50
@nienn nienn requested a review from a team as a code owner March 2, 2022 14:50
@nienn
Copy link
Contributor Author

nienn commented Mar 2, 2022

@humitos I think it's safe to merge this for now. The information can be useful independently of having it's own dedicated section. We can come back and add the section, as discussed in the current PR in #8466 (comment), on a separate PR.

👍 Solved the conflicts.

@humitos humitos merged commit 1fa4f8a into master Mar 2, 2022
@humitos humitos deleted the nienn/docs-link-custom-class branch March 2, 2022 16:03
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.

None yet

3 participants