Skip to content

Lums/sphinx#4

Merged
neoblizz merged 5 commits into
masterfrom
lums/sphinx
Sep 6, 2022
Merged

Lums/sphinx#4
neoblizz merged 5 commits into
masterfrom
lums/sphinx

Conversation

@lums658

@lums658 lums658 commented Aug 30, 2022

Copy link
Copy Markdown
Collaborator

Added initial support scaffolding for sphinx-base documentation.

  • Created sphinx subdirectory under doc
  • Will need to create CI workflow to build and push to gh-pages and/or readthedocs.io
  • There are some particular requirements we will need to set up to make things work properly in the CI workflow. I've put them in doc/sphinx/requirements.txt, and I think they are complete, but there may need to be some experimentation. At some point I was using a custom-compiled doxygen -- that may or may not be completely necessary to use, but if it is, we'll probably want to pre-build it and use custom docker image for CI (if that is possible)
  • Probably don't really need "exhale" as part of sphinx -- should set up to use doxygen directly from breathe
  • Will need to add documentation to code
  • Will need to create narrative in .rst files -- perhaps autogenerate from latex with pandoc?

Moved latex sources to a latex subdirectory under doc

@lums658 lums658 requested review from neoblizz and pratzl August 30, 2022 18:01
@lums658 lums658 self-assigned this Aug 30, 2022

@neoblizz neoblizz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Integrating this into Actions.

@neoblizz neoblizz merged commit 433c3e4 into master Sep 6, 2022
@neoblizz neoblizz deleted the lums/sphinx branch October 23, 2022 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants