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

adapt to the autoapi extension from ansys sphinx theme #1755

Draft
wants to merge 3 commits into
base: doc/documentation-adjustments-new-layout
Choose a base branch
from
Draft

adapt to the autoapi extension from ansys sphinx theme #1755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ace9c0
adjustments in the api sidebar
luisaFelixSalles Sep 18, 2024
b8effff
changes in the autoapi layout
luisaFelixSalles Sep 18, 2024
0b89008
Merge branch 'doc/documentation-adjustments-new-layout' into doc/adju…
jorgepiloto Oct 23, 2024
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
28 changes: 0 additions & 28 deletions .ci/build_doc.bat
View file
Open in desktop

This file was deleted.

5 changes: 5 additions & 0 deletions doc/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ if "%SPHINXBUILD%" == "" (
)
set SOURCEDIR=source
set BUILDDIR=build
set AUTOAPI_OUTDIR=source\api

if "%1" == "" goto help
if "%1" == "clean" goto clean

%SPHINXBUILD% >NUL 2>NUL

if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
Expand All @@ -34,6 +36,9 @@ echo.Cleaning files form previous build...
IF EXIST "build" (
rmdir "build" /s /q
)
IF EXIST "source\api" (
rmdir "source\api" /s /q
)
IF EXIST "source\images\auto-generated" (
rmdir "source\images\auto-generated" /s /q
)
Expand Down
13 changes: 8 additions & 5 deletions doc/source/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@
API reference
=============

.. toctree::
:maxdepth: 2
:caption: API reference

ansys.dpf.core
.. toctree::
:maxdepth: 1
:hidden:
:caption: API subpackages

ansys.dpf.core
ansys.dpf.core.operators
ansys.dpf.core.examples

4 changes: 4 additions & 0 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"ansys_sphinx_theme.extension.autoapi",
"sphinx.ext.autosummary",
"enum_tools.autoenum",
"nbsphinx",
Expand Down Expand Up @@ -197,6 +198,9 @@ def reset_servers(gallery_conf, fname, when):
html_favicon = ansys_favicon
html_theme_options = {
"github_url": "https://github.com/ansys/pydpf-core",
"ansys_sphinx_theme_autoapi": {
"project": project,
},
"show_prev_next": False,
"show_breadcrumbs": True,
"additional_breadcrumbs": [
Expand Down
Loading