You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The goal here is to build a documentation similar Read the Docs's documentation. The documentation should include pages about the project and any relevant information to aid in its understanding. Additionally, it should contain pages generated from the code's docstrings, allowing it to be continuously updated alongside code changes.
Use mkdocs to build a documentation site based on the docs folder and the docstrings in the code.
Organize documentation sections and add parts from other branches.
Deploy the documentation in the github-pages.
Build and deploy the documentation automatically in the CI.
Salut @LilianBsc, le README a été mis à jour dans le main. J'ai modifié ce que je connais mais il y a certaines parties que je ne maitrise pas, notamment toute la partie Docker. Si tu as des questions, n'hésite pas à les poser sur Slack :)
Hello
Pour la partie docker le service frontend ne compile toujours pas
Du coup pour info pour build et run j'utilise les scripts avec arguments suivants
Hello Pour la partie docker le service frontend ne compile toujours pas Du coup pour info pour build et run j'utilise les scripts avec arguments suivants
Correction, pour le build /docker/build.sh bloom-init
Mais je me dis que ça aurait un sens de migrer le code de build vers bloom-backend plutôt que bloom-init qui partagent la même image docker (construite une seule fois)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The goal here is to build a documentation similar Read the Docs's documentation. The documentation should include pages about the project and any relevant information to aid in its understanding. Additionally, it should contain pages generated from the code's docstrings, allowing it to be continuously updated alongside code changes.
mkdocsto build a documentation site based on thedocsfolder and the docstrings in the code.