Skip to content

Conversation

@prkumar
Copy link
Owner

@prkumar prkumar commented Apr 5, 2025

Migrate documentation from Sphinx to mkdocs

@prkumar prkumar requested a review from leiserfg April 5, 2025 20:00
@prkumar prkumar force-pushed the migrate-to-mkdocs branch from 22ba7f8 to c1257df Compare April 5, 2025 20:01
@prkumar prkumar enabled auto-merge April 5, 2025 20:03
@prkumar prkumar force-pushed the migrate-to-mkdocs branch from c1257df to c47b9f3 Compare April 5, 2025 20:11
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Apr 5, 2025

Deploying uplink with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5681809
Status: ✅  Deploy successful!
Preview URL: https://6afa9218.uplink-t4a.pages.dev
Branch Preview URL: https://migrate-to-mkdocs.uplink-t4a.pages.dev

View logs

@leiserfg
Copy link
Collaborator

leiserfg commented Apr 5, 2025

Where are you setting these dependencies? ( mkdoc and mkdocs-material)

@leiserfg
Copy link
Collaborator

leiserfg commented Apr 5, 2025

Also, shouldn't the Makefile be in the root? otherwise I think mkdoc won't find the mkdocs.yml.

@prkumar
Copy link
Owner Author

prkumar commented Apr 5, 2025

@leiserfg - Good questions. Made the following changes in the latest commits:

  • Add docs dependency group to pyproject.toml
  • Removed Makefile

@prkumar
Copy link
Owner Author

prkumar commented Apr 5, 2025

Preview: https://23506dfe.uplink-t4a.pages.dev/

@leiserfg
Copy link
Collaborator

leiserfg commented Apr 5, 2025

The doc says uplink works in py2.7

@prkumar
Copy link
Owner Author

prkumar commented Apr 5, 2025

@leiserfg - Good point! Removed. The badge in index.md should update once we push v0.10.0

@prkumar prkumar merged commit 87bdc5d into master Apr 6, 2025
8 checks passed
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.

3 participants