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

Deployment Setup for MkDocs Documentation Site #87

Merged
merged 4 commits into from
Jan 27, 2024

Conversation

eli64s
Copy link
Owner

@eli64s eli64s commented Jan 27, 2024

Summary

This pull request brings several updates to the MkDocs documentation site, along with setup for automated deployment.

Key Changes

  1. Markdown Files Update: Revised and updated various markdown files in the docs directory to enhance the quality and comprehensiveness of documentation.

  2. Custom Styling and Scripting: Added custom CSS and JavaScript scripts to integrate with MkDocs site.

  3. Dependency Management: Updated the poetry documentation dependencies in pyproject.toml.

  4. GitHub Actions for Automated Deployment: Add GitHub Actions workflow to automate documentation site building and deploying to GitHub Pages.

@codecov-commenter
Copy link

codecov-commenter commented Jan 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3beb6da) 88.84% compared to head (dc9dda6) 89.06%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #87      +/-   ##
==========================================
+ Coverage   88.84%   89.06%   +0.21%     
==========================================
  Files          29       29              
  Lines        1372     1372              
==========================================
+ Hits         1219     1222       +3     
+ Misses        153      150       -3     

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

@eli64s eli64s added documentation Improvements or additions to documentation feature labels Jan 27, 2024
@eli64s eli64s self-assigned this Jan 27, 2024
@eli64s eli64s merged commit 701c456 into main Jan 27, 2024
5 checks passed
@eli64s eli64s deleted the feature/mkdocs-integration branch March 1, 2024 04:40
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 feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants