Skip to content

Update settings doc to speed up build time #352

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 28, 2022
Merged

Update settings doc to speed up build time #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 1 addition & 9 deletions doc/settings_rstgen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,22 +120,14 @@ def _populate_rst_from_settings(rst_dir, cls):
has_named_object = hasattr(cls, "child_object_type")
with open(rstpath, "w") as r:
# Populate initial rst
r.write(":orphan:\n\n")
r.write(f".. _{file_name}:\n\n")
r.write(f"{cls_name}\n")
r.write(f'{"="*(len(cls_name))}\n\n')
r.write(f".. currentmodule:: ansys.fluent.core.solver.settings.{file_name}\n\n")
r.write(f".. autoclass:: {cls_name}\n")
r.write(f"{istr1}:show-inheritance:\n")
r.write(f"{istr1}:undoc-members:\n")
member_str = f"{istr1}:members: fluent_name"
if has_children:
member_str += ", child_names"
if has_commands:
member_str += ", command_names"
if has_arguments:
member_str += ", argument_names"
member_str += "\n"
r.write(member_str)

if has_children:
r.write(f".. rubric:: Children\n\n")
Expand Down
2 changes: 2 additions & 0 deletions doc/source/api/core/solver/flobject.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _ref_flobject:

:orphan:

flobject
========
.. currentmodule:: ansys.fluent.core.solver
Expand Down
10 changes: 1 addition & 9 deletions doc/source/api/core/solver/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,12 +167,4 @@ commands.

Settings Objects Root
---------------------
:ref:`Settings root<root>`

.. toctree::
Copy link
Contributor

Choose a reason for hiding this comment

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

@dnwillia-work This was what was inserting the TOC in each file.

Copy link
Collaborator

@dnwillia-work dnwillia-work Apr 28, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, makes sense, along with the _autosummary/settings/* line below..

:maxdepth: 1
:glob:
:hidden:

_autosummary/settings/*
flobject
:ref:`Settings root<root>`