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

Additional instructions needed to build documentation #2608

Open
gavin-k-lee opened this issue Jun 13, 2022 · 0 comments
Open

Additional instructions needed to build documentation #2608

gavin-k-lee opened this issue Jun 13, 2022 · 0 comments

Comments

@gavin-k-lee
Copy link
Contributor

gavin-k-lee commented Jun 13, 2022

Describe the bug
When building the documentation, one needs to add submodules when cloning.

To Reproduce
Steps to reproduce the behavior:

  1. Follow instructions on: https://github.com/SwissDataScienceCenter/renku/blob/master/docs/how-to-guides/contributing/documentation.rst#L10
  2. Run pipenv run make install
  3. See error
PS C:\Users\leega\Documents\renku\docs> pipenv run make html
Running Sphinx v3.5.4
Initializing Spelling Checker 7.3.2

Extension error:
Could not import extension cheatsheet (exception: No module named 'cheatsheet')

Expected behavior
Documentation builds.

What needs to be added to dcumentation
One needs to run

git clone --recurse-submodules [email protected]:SwissDataScienceCenter/renku.git

when cloning the repo first!

Screenshots and/or execution output
Untitled

Run environment (please complete the following information):

  • Windows Powershell
  • Python 3.9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant