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.

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

Jump to bottom

changes in the sidebar of the examples section #1752

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

changes in the sidebar of the examples section #1752

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
36 changes: 36 additions & 0 deletions doc/source/_templates/custom_examples.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links" aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav">
<p style="font-weight:bold;" aria-label="Fundamentals" role="heading" aria-level="2">Fundamentals</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="00-basic/index.html">Basic DPF examples</a></li>
</ul>
<p style="font-weight:bold;" aria-label="Intermediate" role="heading" aria-level="2">Intermediate</p> <ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="01-transient_analyses/index.html">Transient analysis examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="02-modal_analyses/index.html">Modal analysis examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="03-harmonic_analyses/index.html">Harmonic analysis examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="04-advanced/index.html">Advanced and miscellaneous examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="05-file-IO/index.html">File manipulation and input-output examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="06-plotting/index.html">Plotting examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="07-distributed-post/index.html">Examples for postprocessing on distributed processes</a></li>
<li class="toctree-l1"><a class="reference internal" href="08-python-operators/index.html">Examples of creating custom operator plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="09-averaging/index.html">Averaging examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="10-mesh_operations/index.html">Mesh operations examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="11-cyclic-symmetry/index.html">Cyclic symmetry examples</a></li>
</ul>
<p style="font-weight:bold;" aria-label="Advanced" role="heading" aria-level="2">Advanced</p> <ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="12-fluids/index.html">Fluids examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="13-streamlines/index.html">Streamlines examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="14-lsdyna/index.html">LS-Dyna examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="15-cfx/index.html">CFX examples</a></li>
</ul>
</div>
</nav>
</div>
</div>


<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
6 changes: 4 additions & 2 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
autodoc_mock_imports = ["ansys.dpf.core.examples.python_plugins"]

# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
Expand Down Expand Up @@ -237,7 +237,9 @@ def reset_servers(gallery_conf, fname, when):
#
# html_sidebars = {}

html_sidebars = {"testing": []}
html_sidebars = {"testing": [],
"examples/**": ["custom_examples"],
}


# -- Options for HTMLHelp output ---------------------------------------------
Expand Down
Loading