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

Exclude some fields from documentation without making them private #11

Open
Tracked by #8
momchil-flex opened this issue Oct 23, 2023 · 2 comments
Open
Tracked by #8
Assignees

Comments

@momchil-flex
Copy link

There are some inherited fields that in some classes can be modified by the users, while in others they can't be (set as Literal[single_option] = single_option). To avoid confusion, it could be better to completely avoid documenting those fields in classes where they cannot be modified.

The two examples currently are monitor.colocate in some monitors, and monitor.interval_space in some monitors. There could be others in the future too.

@tylerflex
Copy link

tylerflex commented Feb 1, 2024

can this be closed?

@daquinteroflex
Copy link
Collaborator

This is currently pretty tricky to do within our sphinx functionality and configuration. This is some functionality that we can implement within our custom sphinx extension in a more defined manner.

Hence, will migrate this issue to the autoflex documentation extension exploration project.

@daquinteroflex daquinteroflex transferred this issue from flexcompute/tidy3d Jul 25, 2024
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

No branches or pull requests

3 participants