-
Notifications
You must be signed in to change notification settings - Fork 458
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
Major documentation update #49
Conversation
The user directory contains directories for installation, individual modules, and running the test suite. The dev directory includes info on the doxygen API documentation, building sphinx documentation locally, and will include information on adding new tests to the testing suite.
AeroDyn and BeamDyn docs are still in rough shape and need much cleanup; compiles on local sphinx fine
- show execution documentation first - improve section for adding test - remove general software design links
Restructure high-level contents; put installing, testing, user, dev, and cdash at same level.
Here are the regression test results for this pull request:
|
I didn't go too far in depth with reading anything, but I browsed around the documentation for a bit and it looks like there is plenty of it, and I could find my way around, and it looks good. 👌 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great. Thanks. I just noticed a couple of things in the Aerodyn documentation.
- Random sentences appear in bold. For instance in the "Unsteady Airfoil Aerodynamics Options" section.
- Could we turn off the section numbering beyond a certain level. We have sections that are numbered as "4.1.2.3.4. Unsteady Airfoil Aerodynamics Options".
- All figures seem to be missing.
If we want to target these issues on the next release, that's fine too.
Thanks for the feedback, @gantech Random sentences appear in bold. For instance in the "Unsteady Airfoil Aerodynamics Options" section. Could we turn off the section numbering beyond a certain level. We have sections that are numbered as "4.1.2.3.4. Unsteady Airfoil Aerodynamics Options". All figures seem to be missing. |
This pull request substantially updates the readthedocs documentation in OpenFAST. Major updates include
A live version can be viewed at http://mas-openfast-fork.readthedocs.io/en/latest/index.html