Skip to content

Consistent doc build dependencies with pyfluent #119

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 6 commits into from
Sep 7, 2022
Merged

Consistent doc build dependencies with pyfluent #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a4d1f19
Consistent doc build dependencies with pyfluent
dnwillia-work Sep 2, 2022
0acdc86
Build process consistent with pyfluent
dnwillia-work Sep 6, 2022
40bfa40
Update to latest Sphinx API call
dnwillia-work Sep 6, 2022
2356507
Make .gitignore consistent with pyfluent
dnwillia-work Sep 6, 2022
60530ea
Update after black check
dnwillia-work Sep 6, 2022
2dc4506
Remove duplicate copy of example script
dnwillia-work Sep 6, 2022
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
9 changes: 6 additions & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ instance/

# Sphinx documentation
doc/_build/
_autosummary
doc/source/examples
doc/build_errors.txt

# PyBuilder
.pybuilder/
Expand Down Expand Up @@ -118,9 +121,9 @@ celerybeat.pid
# Environments
.env
.venv
env/
venv/
ENV/
env*/
venv*/
ENV*/
env.bak/
venv.bak/

Expand Down
4 changes: 3 additions & 1 deletion doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
#

# You can set these variables from the command line.
SPHINXOPTS = -v -j auto -W --keep-going -w build_errors.txt -N
SPHINXOPTS = -j auto -W --keep-going -w build_errors.txt -N -q
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
Expand All @@ -21,6 +22,7 @@ help:

# customized clean due to examples gallery
clean:
rm -rf build_errors.txt
rm -rf $(BUILDDIR)/*
rm -rf $(SOURCEDIR)/examples
find . -type d -name "_autosummary" -exec rm -rf {} +
3 changes: 2 additions & 1 deletion doc/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ if "%SPHINXBUILD%" == "" (
)
set SOURCEDIR=source
set BUILDDIR=_build
set SPHINXOPTS=-v -j auto -W --keep-going -w build_errors.txt -N
set SPHINXOPTS=-j auto -W --keep-going -w build_errors.txt -N -q

if "%1" == "" goto help
if "%1" == "clean" goto clean
Expand All @@ -38,6 +38,7 @@ goto end
rmdir /s /q %BUILDDIR% > /NUL 2>&1
rmdir /s /q %SOURCEDIR%\examples > /NUL 2>&1
for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d"
del build_errors.txt > /NUL 2>&1
goto end

:help
Expand Down
6 changes: 2 additions & 4 deletions doc/source/_ext/autodocclass.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,9 @@ def add_directive_header(self, sig: str) -> None:
super().add_directive_header(sig)
self.add_line(" ", self.get_sourcename())

def add_content(
self, more_content: Optional[StringList], no_docstring: bool = False
) -> None:
def add_content(self, more_content: Optional[StringList]) -> None:

super().add_content(more_content, no_docstring)
super().add_content(more_content)

source_name = self.get_sourcename()
object = self.object
Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
262 changes: 0 additions & 262 deletions doc/source/examples/00-postprocessing/post_processing_exhaust_manifold.py
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion examples/00-postprocessing/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Postprocessing examples
========================
=======================
These examples show how to use external packages to postprocess Fluent
results.
1 change: 0 additions & 1 deletion examples/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
========
Examples
========
Add examples here for PyFluent-Visualization.

..
This toctree must be a top level index to get it to show up in
Expand Down
12 changes: 6 additions & 6 deletions requirements/requirements_doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Sphinx==4.5.0
Sphinx==5.1.0
jupyter_sphinx==0.4.0
numpydoc==1.2
ansys-sphinx-theme==0.4.2
pypandoc==1.7.2
numpydoc==1.4.0
ansys-sphinx-theme==0.5.1
pypandoc==1.8.1
pytest-sphinx==0.4.0
sphinx-autobuild==2021.3.14
sphinx-autodoc-typehints==1.17.0
sphinx-autodoc-typehints==1.19.1
sphinx-copybutton==0.5.0
sphinx-gallery==0.10.1
sphinx-gallery==0.11.0
sphinx-notfound-page==0.8.3
sphinxcontrib-websupport==1.2.4
sphinxemoji==0.2.0
Expand Down