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

Documentation setup and first draft #4

Merged
merged 4 commits into from
Feb 15, 2024

Conversation

frgigr
Copy link
Collaborator

@frgigr frgigr commented Feb 13, 2024

As just discussed in the last WP2 meeting, this PR provides the setup and a first draft of the documentation material, built with Jupyter Book.

GitHub Pages option has to be activated after merging (Settings -> Code and automation -> Pages), choosing the docs folder, from main branch, as input.

@frgigr
Copy link
Collaborator Author

frgigr commented Feb 13, 2024

Addressing pipeline issue

@frgigr
Copy link
Collaborator Author

frgigr commented Feb 13, 2024

The sphinx-book-theme package was updated to version 1.1.1 2h ago, breaking the jupyter book compilation. Bug report sent here. I'll wait for a fix, otherwise I'll revert back to 1.1.0 version

@frgigr
Copy link
Collaborator Author

frgigr commented Feb 13, 2024

The previous issue has been fixed, bumping sphinx-book-theme package to version 1.1.2. Build job succeeded!

GitHub Pages activated! The PR has to be merged, as GitHub pages have to be deployed from the main repository. Ready to be merged if there're no objection

@frgigr frgigr added the documentation Improvements or additions to documentation label Feb 13, 2024
@ttedeschi
Copy link
Collaborator

Merging since there are no further comments

@ttedeschi ttedeschi merged commit 0f9bab5 into ICSC-Spoke2-repo:main Feb 15, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants