Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial commit for docs #683

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Conversation

KaruroChori
Copy link
Contributor

@KaruroChori KaruroChori commented Jan 12, 2025

Follow up of the discussion here.
I started adding everything needed to handle the docs.

  • tsdoc redirected
  • doxygen generated
  • mkdocs generated
  • branding (there is some stuff which is specific to the project I am adapting this code from which should be removed/edited)
  • github worflows
  • seeding (preparing the gh-branch for the first run, basically a cleanup and an index page to add manually)
  • testing

There are several styles available for mkdocs, we might replace it with something else.

Assuming you have all the dependencies installed, to test the generated docs:

./dist/make-docs.sh && cd dist/website && http-server

or something equivalent.

Dependencies:

python3 -m pip install mkdocs mkdocs-github-admonitions-plugin mkdocs-get-deps pymdown-extensions mdx_truly_sane_lists

and clearly doxygen must be installed as well.
These dependencies are only if one wants to build the docs themselves, they will be handled automatically in the CI.

karurochari added 2 commits January 12, 2025 17:10
Changes in master will be added to `next`.
Changes due to releases will be added to `latest`.
Different releases will have their own folder.
@KaruroChori
Copy link
Contributor Author

KaruroChori commented Jan 12, 2025

How did some platforms break, as I have not even touched them I wonder.

@saghul
Copy link
Owner

saghul commented Jan 12, 2025

Thanks for getting the ball rolling! ❤️‍🔥

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