create documentation #47
Open
isabellaascione wants to merge 7 commits intoMetOffice:profsea-climatefrom
Open
Conversation
…ow for deploying documentation
Update actions versions
remove html-all
Greg Munday (gregrmunday)
added
documentation 📜
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request includes initial demonstration to build documentation for the profsea-climate project.
Pull request related to #46
Website:
https://isabellaascione.github.io/ProFSea-tool/
The changes were made inside the profsea-climate branch and the documentation is deployed from profsea-climate branch.
Below is a summary of the changes made:
Configured the Sphinx documentation build process using the Makefile and make.bat files.
Ensured the documentation builds successfully into HTML format under the html folder
included environment.yml file with dependencies required for building the documentation, such as Sphinx and related extensions.
Verified the generated HTML files, including:
It might be useful to discuss what structure would you like to have for the documentation. For the sake of the demonstration I added development_guidelines, user_guide, references but this can be changed / have subfolder structure if needed.