Repository navigation
spin document build problems #24713
Description
Activity
The first sphinx complaint looks fixable by copying
doc/source/reference/random/examples/cythonfrom main.That command is for regular building of the html docs. I believe the release command was always
make dist. Either way, afterspin docs --buildI think you can run these commands locally to get a zip file right now:build/dist.tar.gz: real-dist real-dist: html-build cp -r build/html build/dist cd build/html && zip -9r ../dist/numpy-html.zip . cd build/dist && tar czf ../dist.tar.gz * chmod ug=rwX,o=rX -R build/dist find build/dist -type d -print0 | xargs -0r chmod g+s
I can have a look at integrating it into the
spin docsCLI. How aboutspin docs --distas the command?I'll have a look at fixing up the warnings as well.
- added a commit that references this issue
on Sep 15, 2023 How about spin docs --dist
Sounds good. The
make merge-doccommand is what I use to update numpy.org and it runsmake build/dist.tar.gz. I'd like to get rid of the Makefile, so if there were a single command that replacedmerge-docI would be happy.EDIT: For now we could just fix the Makefile so that
merge-docruns$(PYTHON) -m spin docs -dist.See my linked PR. For
merge-doc, this should work already:spin docs merge-doc.I'd like to get rid of the Makefile
Hmm, I wasn't planning on touching that. Translating the Makefile line by line into Python code in
.spin/cmds.pywill probably result in running the same commands through subprocess calls.Reacted by Stefan van der WaltThe important documentation is
RELEASE_WALKTHROUHGH.rst:)Translating the Makefile line by line into Python code
Most of it is never used, all we need is the ability to make docs.
Most of it is never used, all we need is the ability to make docs.
Maybe let's just delete the parts we don't need for now?
The important documentation is
RELEASE_WALKTHROUHGH.rst:)Ah, I forgot. Would be nice if we'd delete
HOWTO_RELEASE.rst. I'm about to sign off, I hope the added docs are enough for you right now? Basically andmake XXXyou can replace byspin docs XXX.- added a commit that references this issue
on Nov 11, 2023
Running
python -m spin docs --buildThe whole
randommodule was taken from main, so should probably have fixes for using meson.On the plus side, the correct numpy version (1.26.0rc1) is built and used.