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

[nasa/Cryptolib#382] Sphinx Documentation Refresh POC #383

Merged
merged 8 commits into from
Jan 13, 2025

Conversation

rjbrown2
Copy link
Member

@rjbrown2 rjbrown2 commented Jan 8, 2025

WIP: Documentation Updates (Still need more updates)
Updated Docker Container to include Sphinx dependencies.
Updated make command to build docs - includes support scripts.

Install dependencies:

  • python3-sphinx
  • python3-sphinx-rtd-theme
  • python3-myst-parser

OR

Run from within the debug container support/scripts/docker_debug.sh

make docs

Closes #382

@rjbrown2 rjbrown2 added the enhancement New feature or request label Jan 8, 2025
@rjbrown2 rjbrown2 self-assigned this Jan 8, 2025
@rjbrown2 rjbrown2 linked an issue Jan 8, 2025 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.97%. Comparing base (14ee573) to head (6a4248f).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #383   +/-   ##
=======================================
  Coverage   75.97%   75.97%           
=======================================
  Files          81       81           
  Lines       22263    22263           
  Branches     1807     1807           
=======================================
  Hits        16914    16914           
  Misses       4707     4707           
  Partials      642      642           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jlucas9
Copy link
Collaborator

jlucas9 commented Jan 9, 2025

make docs
./support/scripts/build_docs.sh
Creating Documentation Wiki Pages
Running Sphinx v5.3.0
making output directory... done
WARNING: sphinx_rtd_theme (< 0.3.0) found. It will not be available since Sphinx-6.0

Theme error:

no theme named 'sphinx_rtd_theme' found (missing theme.conf?)

Can we get those dependencies added to the container?
Just kidding - should the build_docs.sh script use docker to make those calls?
Also add these build doc files to the .gitignore?

@rjbrown2
Copy link
Member Author

rjbrown2 commented Jan 10, 2025

make docs
./support/scripts/build_docs.sh
Creating Documentation Wiki Pages
Running Sphinx v5.3.0
making output directory... done
WARNING: sphinx_rtd_theme (< 0.3.0) found. It will not be available since Sphinx-6.0

Theme error:

no theme named 'sphinx_rtd_theme' found (missing theme.conf?)

Can we get those dependencies added to the container? Just kidding - should the build_docs.sh script use docker to make those calls? Also add these build doc files to the .gitignore?
======

Try: python3-sphinx-rtd-theme (seems like you are trying this locally? are you missing a dependency?)

Made the requested modifications to the .gitignore

Updated build of documentation to occur inside container rather than locally.

@Donnie-Ice Donnie-Ice merged commit e1f8cea into dev Jan 13, 2025
12 checks passed
@Donnie-Ice Donnie-Ice deleted the 382-documentation-refresh branch January 13, 2025 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Documentation Refresh
5 participants