Skip to content

build: Update local doc build instructions#3671

Merged
hpohekar merged 4 commits into
mainfrom
fix/check_latest_image
Jan 28, 2025
Merged

build: Update local doc build instructions#3671
hpohekar merged 4 commits into
mainfrom
fix/check_latest_image

Conversation

@hpohekar
Copy link
Copy Markdown
Collaborator

@hpohekar hpohekar commented Jan 27, 2025

closes #3480

No need to execute following scripts manually to build all docs locally.

python doc/api_rstgen.py
python doc/datamodel_rstgen.py
python doc/tui_rstgen.py
python doc/settings_rstgen.py

Just execute the following commands to build all docs locally.

pip install ansys-fluent-core[docs]
cd doc
set BUILD_ALL_DOCS=1
set FLUENT_IMAGE_TAG=v0.25.1
make html

@github-actions github-actions Bot added documentation Documentation related (improving, adding, etc) maintenance General maintenance of the repo (libraries, cicd, etc) CI/CD labels Jan 27, 2025
@hpohekar hpohekar merged commit 445ddc6 into main Jan 28, 2025
@hpohekar hpohekar deleted the fix/check_latest_image branch January 28, 2025 04:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation related (improving, adding, etc) maintenance General maintenance of the repo (libraries, cicd, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Local Documentation Builds UX Could Be Better

3 participants