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

Feature/datateam 36/update docs #43

Merged
merged 14 commits into from
Oct 10, 2024
Merged

Conversation

nelsonwmoore
Copy link
Collaborator

Documentation Update 📜

  • create example notebook of bento-mdf package use
  • create GitHub workflow for Sphinx documentation generation and GitHub Pages deployment
  • move existing documentation from README to /docs/

Bug fixes 🐛

  • add default UTF-8 encoding when validator opens & loads YAML instances

- add default UTF-8 encoding when validator opens & loads YAML instances
- reenable validator test to load and validate sample crdc_dh MDF
- update documentation-building dependencies to resolve version issues with adding Sphinx
- initial structure for sphinx & read the docs
add term, validator, and diff examples
- move old README content to docs in mdf.md and mdf_tools.mdf
- configure conf.py. TODO: get autoapi working, running into bugs with it currently. commented out autoapi functionality for now.
workflow for github pages deployment
update to test docs generation on gh-pages
troubleshooting html docs build
- reduce size of output for validator examples
- edit workflow so docs only build & push to gh-pages when pushed to main branch
@nelsonwmoore nelsonwmoore added the documentation Improvements or additions to documentation label Oct 10, 2024
@nelsonwmoore nelsonwmoore merged commit 87ecc08 into main Oct 10, 2024
12 checks passed
@nelsonwmoore nelsonwmoore deleted the feature/DATATEAM-36/update-docs branch October 10, 2024 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant