Skip to content

Update the command for building the documentation#2622

Merged
bouweandela merged 1 commit intomainfrom
update_doc_build
Apr 11, 2022
Merged

Update the command for building the documentation#2622
bouweandela merged 1 commit intomainfrom
update_doc_build

Conversation

@bouweandela
Copy link
Copy Markdown
Member

@bouweandela bouweandela commented Apr 6, 2022

Description

The command python setup.py build_sphinx is deprecated, see sphinx-doc/sphinx#10040. It is recommended that we use sphinx-build instead.


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.


To help with the number of pull requests:

@bouweandela bouweandela marked this pull request as ready for review April 6, 2022 09:29
Copy link
Copy Markdown
Contributor

@valeriupredoi valeriupredoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cheers muchly @bouweandela 🍺 Do you know if this is done differently on an OSX so we can test it with a Github Action too? (in another PR of course, if need be)

@bouweandela
Copy link
Copy Markdown
Member Author

I would think it's the same, you can find the documentation on sphinx-build here: https://www.sphinx-doc.org/en/master/man/sphinx-build.html

@bouweandela bouweandela merged commit 5188803 into main Apr 11, 2022
@bouweandela bouweandela deleted the update_doc_build branch April 11, 2022 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants