Skip to content

doc: Add a documentation website generator - #129

Open
Grillo-0 wants to merge 1 commit into
developfrom
website-doc
Open

doc: Add a documentation website generator#129
Grillo-0 wants to merge 1 commit into
developfrom
website-doc

Conversation

@Grillo-0

@Grillo-0 Grillo-0 commented May 14, 2026

Copy link
Copy Markdown
Member

The project is growing and if we want to attract new uses/contributors we need a proper documentation website. Let's use sphinx + hawkmoth for the job. The configuration seems simple, it can handle C code and it's is a solid option, the kernel uses it.

To build the documentation run:

meson compile -C build docs

This first commit it doesn't try to document all the code. It just bootstraps the setup and creates some initial documentation to be used as example for future commits.

@Grillo-0 Grillo-0 self-assigned this May 14, 2026
@Grillo-0 Grillo-0 linked an issue May 14, 2026 that may be closed by this pull request
@Grillo-0
Grillo-0 force-pushed the website-doc branch 3 times, most recently from 3e1b24a to 71ede94 Compare May 17, 2026 21:40
@arthurvergacas

Copy link
Copy Markdown
Collaborator

Question: does it make sense to move contributing.md, code of conduct.md, etc, to docs/source/?

Wondering if it's not too hidden for someone new to the project. I guess we could link them in the readme, but it still seems a bit weird, and since they are not markdown, they won't get the nice github rendering

However I also see the pain that it'd be to maintain two files that should be the same. they would fatally drift 😭

I guess the links in readme are the best option?

@artP2

artP2 commented May 21, 2026

Copy link
Copy Markdown
Contributor

add hawkmoth dep

@Grillo-0

Copy link
Copy Markdown
Member Author

Question: does it make sense to move contributing.md, code of conduct.md, etc, to docs/source/?

Wondering if it's not too hidden for someone new to the project. I guess we could link them in the readme, but it still seems a bit weird, and since they are not markdown, they won't get the nice github rendering

However I also see the pain that it'd be to maintain two files that should be the same. they would fatally drift 😭

I guess the links in readme are the best option?

I was having the same thoughts. And yeah, I think putting a link to the website is enough. The potential contributor will find it.

@Grillo-0
Grillo-0 force-pushed the website-doc branch 2 times, most recently from 6a095a9 to a1edd4c Compare May 22, 2026 04:15
@Grillo-0

Copy link
Copy Markdown
Member Author

add hawkmoth dep
@artP2 done

@artP2

artP2 commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

rebase the branch

@JeanJPNM JeanJPNM 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.

lgtm, just need to fix the merge conflicts

@Grillo-0
Grillo-0 force-pushed the website-doc branch 2 times, most recently from e8cfad1 to 99d9d7b Compare August 18, 2026 02:40
The project is growing and if we want to attract new uses/contributors
we need a proper documentation website. Let's use sphinx + hawkmoth for
the job. The configuration seems simple, it can handle C code and it's
is a solid option, the kernel uses it.

To build the documentation run:

meson compile -C build docs

This first commit it doesn't try to document all the code. It just
bootstraps the setup and creates some initial documentation to be used
as example for future commits.
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.

Formalize the way we add documentation to the code

4 participants