-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Add Addons customization docs #11888
Conversation
This is start for this work, and mostly just pulls examples from the Mkdocs page over to the Addons docs. I think there's more to do here with examples, but I think this is a reasonable starting point.
I would not document the CSS variables yet since we are having a discussion about that in readthedocs/addons#473 and we are thinking about removing support for them for now while we explore how to it in a reliable way. |
This reverts commit 755bfff.
This reverts commit a371da0.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. There are a few pending decisions we may want to decide before merging; but other than that, looks like a good first step.
docs/user/addons.rst
Outdated
- ``--readthedocs-flyout-dd-font-size`` | ||
- ``--readthedocs-flyout-dt-font-size`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@agjohnson mentioned these dd-
where not necessary in readthedocs/addons#488 (comment), so I'm not sure if he is planning to remove them.
@humitos I can remove the CSS variable reference if we aren't ready to fully list them out? I'd like to get at least the custom event stuff unblocked here if possible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good. I think there are benefits to authoring this type of documentation in the addons docs, and not a whole lot of benefit to authoring in our application docs. Not important for now, but it's something we should consider more.
* ``versions.current`` - Details about the current version | ||
* ``versions.active`` - List of all active and not hidden versions | ||
|
||
.. dropdown:: Click to see an example of the Addons data |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is another example of documenting this in Addons docs being less work. We have the mock API data in the Addons repo that we keep up to date for testing, this would be better than replicating this data to this repo and it going out of date.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, there's a bunch of room for improvement here, but getting something documented is more important than doing a bunch of infra work to publish the same stuff in another fashion.
Co-authored-by: Anthony <aj@ohess.org>
This is start for this work,
and mostly just pulls examples from the Mkdocs page over to the Addons docs.
I think there's more to do here with examples,
but I think this is a reasonable starting point.
📚 Documentation previews 📚
docs
): https://docs--11888.org.readthedocs.build/en/11888/dev
): https://dev--11888.org.readthedocs.build/en/11888/