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

Create autogenerated dbus docs + default theme change #6124

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

adamkankovsky
Copy link
Contributor

Modified documentation: documentation

Copy link
Contributor

@M4rtinK M4rtinK left a comment

Choose a reason for hiding this comment

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

Looks very nice, good job! :)

Some smaller nitpicks (feel free to handle in this PR or in a followup):

  • on some pages properties are sometimes showsn side-by-side, I saw it here for example:

https://anaconda-autogenerated-dbus-docs.readthedocs.io/en/latest/autoapi/pyanaconda/modules/network/firewall/firewall_interface/index.html
https://anaconda-autogenerated-dbus-docs.readthedocs.io/en/latest/autoapi/pyanaconda/modules/services/services_interface/index.html
https://anaconda-autogenerated-dbus-docs.readthedocs.io/en/latest/autoapi/pyanaconda/modules/subscription/subscription_interface/index.html

It seems to be somehow dynamic, not showing up when I put the page to a narrow vertical browser window

  • the connect_signals() method is shown even though it is not part of the DBus interface - I guess we could just filter this one out manually, but it would be ideal to somehow match what gets exported as DBus interface and what not. Like, theoretically we could drop any method that does not start with a big letter, as the DBus convention requires camel case method names starting with big letter for methods. ;-)

  • I think it would be nice to eventually have some summary for each module on the top level page listing all the DBus modules:

https://anaconda-autogenerated-dbus-docs.readthedocs.io/en/latest/modules.html

I guess we could have a summary in the interface class & fetch it when generating the docs, or something similar.

  • there is some weird formatting of the embedded source code, with some of the decorators not being aligned with the methods, for example here:

https://anaconda-autogenerated-dbus-docs.readthedocs.io/en/latest/_modules/pyanaconda/modules/timezone/timezone_interface.html#TimezoneInterface.IsUTC

Note how some of the decorators have jumped from the method definitions. It is likely related to the [docs] links somehow being placed above the method but after the decorator.

While nothing major I guess this might be a sphinx rendering bug ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants