Merged
Conversation
Moved documentation source files from docs/source to the root of docs, updated the Makefile to use the new source directory, and regenerated Sphinx build outputs. This change simplifies the documentation structure and ensures the build process uses the correct paths. Hopefully this is fixed now 😞
Contributor
|
Do you want me to review this now? Also the host still seems to not be working. But its chill :D |
Contributor
|
reverted, start another pr to continue this issue |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
name: PR/Fix Template
about: Create documentation startup for GravityLib in Readthedocs
title: "[PR] Sphinx documentation v.beta1.0"
labels: pullrequest
assignees: 'venus-beetroot'
Pull Request
Summary
This adds documentation in the form of .md files converted to .html through the myst-parser extension for readthedocs.io. I will add more documentation, formatting and files in the upcoming weeks as the project expands
Motivation
We are creating documentation for this project as we expect it to grow and be a mainstream codebase for all V5, written in rust. Documentation allows us to be both organised, as well as allowing the public to read and understand what we did, what was added, and how to implement our code into their own robots.
Checklist Before Submission
[N/A] I HAVE added unit tests for any new functionality or bug fixes (if applicable).
[N/A] I HAVE tested on actual V5 hardware (if applicable).
Testing
Refer to https://gravlib.readthedocs.io and build the changes made to default branch (main) through my account.
Additional Notes
N/A