Skip to content

Proposal/sphinx structure - #6

Merged
po3ts merged 3 commits into
mainfrom
proposal/sphinx-structure
Apr 22, 2026
Merged

po3ts merged 3 commits into
mainfrom
proposal/sphinx-structure

Conversation

@nor-bot

@nor-bot nor-bot commented Apr 22, 2026

Copy link
Copy Markdown
Member

This is a proposal to structure all the documents a the reStructured Text Format to build a documentation page with sphinx.

  • i move all files from input to docs/contributors
  • i converted the markdown-files to reStructured text

If you add github pages the documentation should be build in ci and will the available as html

@nor-bot nor-bot self-assigned this Apr 22, 2026
@nor-bot
nor-bot requested a review from po3ts April 22, 2026 15:28
Enables local doc builds and live preview at 127.0.0.1:8080 via make serve.
@po3ts
po3ts marked this pull request as ready for review April 22, 2026 20:43

@po3ts po3ts left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's great work, thank you! 🙏 I've added a dev container configuration, which allows building and previewing the docs locally without having to install the dependencies on the host system.

@po3ts
po3ts merged commit 979c3fc into main Apr 22, 2026
2 checks passed
@nor-bot

nor-bot commented Apr 23, 2026

Copy link
Copy Markdown
Member Author

i use uv and at vscode the esbonio plugin

This branch had an error being deployed

1 failed deployment
github-pages — 979c3fc9 Deployed Apr 22, 2026 by po3ts via deploy #3
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.

2 participants