Skip to content
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.

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

Fix for building user-level documentation local #2562

Merged
merged 1 commit into from
Dec 6, 2022

Conversation

steffengraber
Copy link
Contributor

This PR fixes the local creation of user-level documentation with make docs.
Without this fix, this error will be returned:

/bin/sh: 1: htmldoc/resolve_includes.py: Permission denied

With the fix make docs passes without any problems.

To test, I followed the user-level documentation workflow (https://nest-simulator.readthedocs.io/en/latest/developer_space/workflows/documentation_workflow/user_documentation_workflow.html) with a conda setup.

My system:

  • Ubuntu 22.04.1 LTS
  • Python 3.9.15 (in the conda env)

@med-ayssar could you review?

@med-ayssar
Copy link
Contributor

I have run a local build without conda, and it works without throwing any issues back. However, I still have a question.
In doc/CMakeLists.txt at line 101, we still have PYTHON_EXECUTABLE instead of Python_EXECUTABLE. Should not that cause a problem too.

I could not test it because make html is not included as target in the generated Makefile

@steffengraber
Copy link
Contributor Author

In doc/CMakeLists.txt at line 101, we still have PYTHON_EXECUTABLE instead of Python_EXECUTABLE. Should not that cause a problem too.

@med-ayssar Are you on master?
https://github.com/nest/nest-simulator/blob/752f56e5c63bd4dca1a715c87a12fc55e2c2742c/doc/CMakeLists.txt

@med-ayssar
Copy link
Contributor

In doc/CMakeLists.txt at line 101, we still have PYTHON_EXECUTABLE instead of Python_EXECUTABLE. Should not that cause a problem too.

@med-ayssar Are you on master? https://github.com/nest/nest-simulator/blob/752f56e5c63bd4dca1a715c87a12fc55e2c2742c/doc/CMakeLists.txt

Sorry, my mistake. I was taking a look at another window. Though, my first comment is correct. make docs is not issuing any errors.

@steffengraber
Copy link
Contributor Author

Perfect, please add a review.

Copy link
Contributor

@med-ayssar med-ayssar left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@jessica-mitchell jessica-mitchell merged commit 01a7c72 into nest:master Dec 6, 2022
@terhorstd terhorstd added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Jan 18, 2023
@steffengraber steffengraber deleted the fix-local-doc-build branch September 6, 2023 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants