Skip to content

fix: documentation html looks #3918

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 8 commits into from
May 12, 2025
Merged

fix: documentation html looks #3918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b6f0ec3
style: update custom.css to remove background styles and add navbar e…
germa89 May 9, 2025
2271d0f
style: update conf.py to modify sidebar and navbar configurations
germa89 May 12, 2025
0e41cfd
style: refactor custom.css to improve navbar shadow handling and cont…
germa89 May 12, 2025
9f5d729
chore: adding changelog file 3918.fixed.md [dependabot-skip]
pyansys-ci-bot May 12, 2025
963ff97
style: update custom.css and index.rst for navbar background and sect…
germa89 May 12, 2025
6759854
style: remove background style for back-to-top button in custom.css s…
germa89 May 12, 2025
aa1cdf6
Merge branch 'main' into fix/doc-looks
germa89 May 12, 2025
e6c3f95
Merge branch 'main' into fix/doc-looks
germa89 May 12, 2025
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
1 change: 1 addition & 0 deletions doc/changelog.d/3918.fixed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
fix: documentation html looks
31 changes: 16 additions & 15 deletions doc/source/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,29 @@
box-shadow: 0 0rem 0rem 0 rgb(255,172,0); /* var(--pst-color-shadow); */
}

/* Navbar elements */
.bd-navbar-elements {
text-align: center;
}

/* Centering the page content */
.bd-main .bd-content {
display: flex;
justify-content: center;
}

/* Removing navbar shadow */
.sd-shadow-sm {
box-shadow: 0 0rem 0rem rgba(250, 250, 250, 0.6) !important;
}

/* anything related to the light theme */
html[data-theme="light"] {
/* whatever you want to change */
background: rgb(245, 245, 245);
--pst-color-on-background: rgb(35, 35, 35);
--pst-color-background: rgb(245, 245, 245);
--sd-color-card-border-hover: rgb(255,172,0);

.sd-shadow-sm {
box-shadow: 0 0rem 0rem rgba(250, 250, 250, 0.6) !important
}
}

/* anything related to the dark theme */
html[data-theme="dark"] {
/* whatever you want to change */
background: rgb(35, 35, 35);
--pst-color-on-background: rgb(35, 35, 35);
--pst-color-background: rgb(35, 35, 35);
--sd-color-card-border-hover: rgb(255,172,0);

.sd-shadow-sm {
box-shadow: 0 0rem 0rem rgba(250, 250, 250, 0.6) !important
}
}
19 changes: 15 additions & 4 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,23 @@
"json_url": f"https://{cname}/versions.json",
"version_match": switcher_version,
},
# Removing the secondary sidebar for the MAPDL commands
"secondary_sidebar_items": {
# "mapdl_commands/**/**": [],
# "mapdl_commands/index": [],
"**": [], # "page-toc", "edit-this-page", "sourcelink"]
},
"navbar_persistent": [],
"primary_sidebar_end": ["edit-this-page", "sourcelink"],
"navbar_end": [
"search-button-field",
"version-switcher",
"theme-switcher",
"navbar-icon-links",
],
}


BUILD_CHEATSHEET = os.environ.get("BUILD_CHEATSHEET", "false").lower() == "true"

if BUILD_CHEATSHEET:
Expand All @@ -338,10 +353,6 @@
}
html_show_sourcelink = False

html_sidebars = {
"mapdl_commands/**/**": [],
"mapdl_commands/index": [],
}

# -- Options for HTMLHelp output ---------------------------------------------

Expand Down
8 changes: 0 additions & 8 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,6 @@

.. vale off

.. let's hide the `Edit on GitHub` link in this page...
.. and the whole sidebar with it.
.. hideobject::
:class: bd-sidebar-secondary bd-toc
:remove: true
:adjustmargin: true


.. title is given using the

**What do you want to do? I want to...**
Expand Down
3 changes: 2 additions & 1 deletion doc/source/user_guide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@ various advanced methods to visualize, script, and interact with MAPDL, see


Calling MAPDL Pythonically
~~~~~~~~~~~~~~~~~~~~~~~~~~
==========================

MAPDL functions can be called directly from an instance of
:class:`Mapdl <ansys.mapdl.core.mapdl.MapdlBase>` in a Pythonic manner. This is
to simplify calling Ansys, especially when inputs are variables within
Expand Down