search

ansys / pyedb-core

Ansys Electronics Database Python Client Package
https://edb.core.docs.pyansys.com/
MIT License
3 stars 1 forks source link

Navigation pane for API reference section is not formatted correctly #339

Closed PipKat closed 2 weeks ago

PipKat commented 10 months ago

Description of the modifications

The right navigation pane is not listing the modules vertically. Instead it lists three across each line as shown in the following figure. Also, when trying to check the PY files against the rendered doc, it was hard to locate modules in this navigation pane because they were not alphabetical (which is standard). However, newer repos are using external Sphinx AutoAPI extension to generate API reference documentation rather than the native (built-in) sphinx.ext.autodoc extension The Sphinx AutoAPI extension finds and generates content by parsing the source code rather than manually having to build the API doc sections like you have done. I'm tagging @SMoraisAnsys and @RobPasMue for feedback.

image

Useful links and references

No response

SMoraisAnsys commented 10 months ago

I'm not yet familiar with sphinx autoapi extension but I should be using it in other project very soon. If that's okay with you, I'll get back here and do the associated changes once I'm more familiar with that package. I'll assign myself with this issue to not forget about it. Feel free to remove this assignment if someone works on it.

PipKat commented 10 months ago

[like] Kathy Pippert reacted to your message:

From: SMoraisAnsys @.> Sent: Friday, December 15, 2023 10:46:01 AM To: ansys/pyedb-core @.> Cc: Kathy Pippert @.>; Author @.> Subject: Re: [ansys/pyedb-core] Navigation pane for API reference section is not formatted correctly (Issue #339)

[External Sender]

I'm not yet familiar with sphinx autoapi extension but I should be using it in other project very soon. If that's okay with you, I'll get back here and do the associated changes once I'm more familiar with that package. I'll assign myself with this issue to not forget about it. Feel free to remove this assignment if someone works on it.

— Reply to this email directly, view it on GitHubhttps://github.com/ansys/pyedb-core/issues/339#issuecomment-1857667399, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AUHQY25EAMJW2JQJY2AVKGDYJQS6TAVCNFSM6AAAAABATNSO4WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNJXGY3DOMZZHE. You are receiving this because you authored the thread.Message ID: @.***>

drewm102 commented 2 weeks ago

@SMoraisAnsys It looks like this is resolved based on the current documentation here:

https://edb.core.docs.pyansys.com/version/stable/api/index.html

can we close this out? Thanks!

RobPasMue commented 2 weeks ago

Closing!