Skip to content

Add make.bat to make docs in windows. - #475

Merged
cvanelteren merged 3 commits into
Ultraplot:mainfrom
gepcel:test-docs
Jan 16, 2026
Merged

Add make.bat to make docs in windows.#475
cvanelteren merged 3 commits into
Ultraplot:mainfrom
gepcel:test-docs

Conversation

@gepcel

@gepcel gepcel commented Jan 15, 2026

Copy link
Copy Markdown
Collaborator

#474
I've managed to generate docs successful locally with one error that I have to install sphinx-automodapi==0.21.0 to make it work. Don't know why. I can upload the log if needed.

@cvanelteren

Copy link
Copy Markdown
Collaborator

Can't you build by using sphinx-build directly, i.e. python -m sphinx.cmd.build -b html . _build/html

@cvanelteren

Copy link
Copy Markdown
Collaborator

I am fine with adding this. I don't have a windows machine so I cannot test this.

@cvanelteren
cvanelteren self-requested a review January 15, 2026 10:14
Comment thread docs/make.bat
@cvanelteren

Copy link
Copy Markdown
Collaborator

Failing build is due to an example script being live. Feel free to merge when ready. This should only affect windows devs.

@gepcel

gepcel commented Jan 15, 2026

Copy link
Copy Markdown
Collaborator Author

There were an error, and 368 warnings. I uploaded the log here, incase you want to dig in.

The first is about "Could not import extension sphinx_automodapi", I have to change the sphinx-automodapi version from 0.22.0 to 0.21.0 to make this work. The log here:
sphinx-err-log.txt

Then make html succeeded, with a lot of warnings.
make_html_warning.txt

Feel free to merge when ready.

I'll leave it up to you.

@cvanelteren

Copy link
Copy Markdown
Collaborator

Can you try to build on #465 this contains many of the fixes for the docs.

@gepcel

gepcel commented Jan 16, 2026

Copy link
Copy Markdown
Collaborator Author

Can you try to build on #465 this contains many of the fixes for the docs.

I tested with #465. The build succeeded, with 369 warnings.
output-logs.txt

I've randomly checked some pages, seems fine. I've checked all gallery example, all fine. Though it seems that the gallery entry should be in the index.html left sidebar.

image

@cvanelteren

Copy link
Copy Markdown
Collaborator

Gallery is bottom on the list in getting started.

@gepcel

gepcel commented Jan 16, 2026

Copy link
Copy Markdown
Collaborator Author

My bad, sorry.

@cvanelteren

Copy link
Copy Markdown
Collaborator

My bad, sorry.

No worries -- the text should dissapear tho since we already have it right below in the bullet list.

@cvanelteren

Copy link
Copy Markdown
Collaborator

Can you share the warnings?

@gepcel

gepcel commented Jan 16, 2026

Copy link
Copy Markdown
Collaborator Author

I tested with #465. The build succeeded, with 369 warnings. output-logs.txt

I've uploaded the file in the previous comment.

@cvanelteren
cvanelteren merged commit 856d243 into Ultraplot:main Jan 16, 2026
8 of 9 checks passed
@cvanelteren

Copy link
Copy Markdown
Collaborator

Will add this for now for convenience as it has no bearings on the pipelines that are currently active for pushing this RTD or pypi.

cvanelteren added a commit that referenced this pull request Jan 16, 2026
Co-authored-by: Casper van Elteren <caspervanelteren@gmail.com>
@gepcel
gepcel deleted the test-docs branch January 18, 2026 23:53
K-Mirembe-Mercy pushed a commit to K-Mirembe-Mercy/UltraPlot that referenced this pull request Mar 22, 2026
Co-authored-by: Casper van Elteren <caspervanelteren@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants