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

Include legacy documentation in pdf and MS Word format - General & ElastoDyn #805

Merged
merged 9 commits into from
Sep 20, 2021

Conversation

rafmudaf
Copy link
Collaborator

@rafmudaf rafmudaf commented Aug 6, 2021

Feature or improvement description
Until the legacy documentation can be fully converted to the readthedocs / sphinx format, we will be including old documentation in the existing format.

This pull request included documentation general to OpenFAST, as well as documentation on mesh mapping and linearization.

Related issue, if one exists
#804

Impacted areas of the software
Online docs.

Test results, if applicable
See the documentation live at https://raf-openfast.readthedocs.io/en/docs-legacy_docs/source/user/index.html

Copy link
Collaborator

@andrew-platt andrew-platt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. This will work for now.

Should we add a note that the legacy documentation may be out of date?

@rafmudaf
Copy link
Collaborator Author

@andrew-platt good point, I've made that note.

@rafmudaf rafmudaf changed the title Include legacy documentation in pdf and MS Word format Include legacy documentation in pdf and MS Word format - General & ElastoDyn Sep 15, 2021
@rafmudaf
Copy link
Collaborator Author

@jjonkman This pull request is ready for review. I've changed the name to reflect that it covers general OpenFAST documentation and ElastoDyn. I will create another pull request to do the same for the module-specific documentation.

Copy link
Collaborator

@jjonkman jjonkman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @rafmudaf. Very nice to see these documents being added to the OpenFAST documentation as a stop-gap measure! Please find my edits and comments below.

docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/dev/index.rst Outdated Show resolved Hide resolved
docs/source/dev/index.rst Show resolved Hide resolved
docs/source/user/inflowwind/index.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@jjonkman jjonkman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing my edits and comments. I approve now.

@rafmudaf rafmudaf merged commit d76d490 into OpenFAST:dev Sep 20, 2021
@rafmudaf rafmudaf deleted the docs/legacy_docs branch September 20, 2021 21:39
@rafmudaf rafmudaf mentioned this pull request Mar 2, 2022
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants