doc: Add a documentation website generator - #129
Conversation
3e1b24a to
71ede94
Compare
|
Question: does it make sense to move contributing.md, code of conduct.md, etc, to 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? |
|
add hawkmoth dep |
I was having the same thoughts. And yeah, I think putting a link to the website is enough. The potential contributor will find it. |
6a095a9 to
a1edd4c
Compare
|
|
rebase the branch |
JeanJPNM
left a comment
There was a problem hiding this comment.
lgtm, just need to fix the merge conflicts
e8cfad1 to
99d9d7b
Compare
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.
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.