-
Notifications
You must be signed in to change notification settings - Fork 156
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
Build out v4 documentation #860
Conversation
…to test Helix model."
…rel/floris into v4-jf/helix-op-model
Solve merge conflict between v4 and helix branch
…ction examples to floating examples folder.
Added helix model and examples
I think we should merge this branch soon. One last annoying issue that I wouldn't mind fixing is the first comment block, jupyter-book is collapsing white space (new lines and tab indents) in a way that makes the blocks less readable. There appear to be solutions (one is we can adjust the config.yml file to change this behavior) but maybe someone else could have a quick look? |
In the interest of moving this forward, I'm going to go ahead and merge. We can open a PR to develop at a later date to address this. |
Main pull request for documentation updates for v4. See checklist below for assignments.
Places for adding documentation:
The major focus of this PR is on getting the User Reference up to speed with changes for v4. However, adding to the Theory and Background and Developer Reference sections is also encouraged :)
When adding documentation to the User Reference, consider:
Assignments
WindRose
,TimeSeries
,WindTIRose
) @paulf81Floating wind @baycPlease go ahead and push changes to this branch (v4-ms/docs). To see the compiled docs after you have pushed, see https://misi9170.github.io/floris/index.html (you'll need to wait a few minutes for them to build).
Final steps: