Skip to content

Conversation

@H0R5E
Copy link
Contributor

@H0R5E H0R5E commented Mar 4, 2022

I have been working on moving our docs compilation to github actions but on the way I noticed that the docs on the dev branch were not compiling properly. This PR fixes the issues and preps the dev branch for moving to compilation using Actions.

The issues were:

  • Incorrect use of the include directive. Files to be included this way should be placed in the _include folder.
  • Not escaping * in a docstring, which sphinx thinks is a bold formatting token.

@H0R5E H0R5E requested a review from kmruehl March 4, 2022 18:01
@kmruehl kmruehl added Added Mass related to added mass Documentation related to docs and removed Added Mass related to added mass labels Mar 7, 2022
@kmruehl
Copy link
Collaborator

kmruehl commented Mar 10, 2022

@H0R5E thanks, merging this now

@kmruehl kmruehl merged commit e338e65 into WEC-Sim:dev Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation related to docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants