#14 - Bootstrap documentation #21
Conversation
✅ Deploy Preview for recolto ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| tools: | ||
| nodejs: "18" | ||
| commands: | ||
| - mkdir --parents $READTHEDOCS_OUTPUT/html/ |
There was a problem hiding this comment.
where is $READTHEDOCS_OUTPUT defined? (as well as $READTHEDOCS_LANGUAGE, and VERSION)
There was a problem hiding this comment.
These variables are set by ReadTheDocs when it builds the documentation.
see https://docs.readthedocs.io/en/stable/build-customization.html#override-the-build-process & https://makina-corpus.com/logiciel-libre/publier-documentation-vitepress-sur-read-docs for more information
| { icon: 'github', link: 'https://github.com/makinacorpus/recolto' } | ||
| ], | ||
| sidebar: generateSidebar({ | ||
| documentRootPath: 'content', |
There was a problem hiding this comment.
I did make some tests right here:
- with the suggested "content": got the following error:
failed to load config from /Users/…/dev/recolto-makina/docs/.vitepress/config.ts
failed to start server. error:
ENOENT: no such file or directory, scandir '/Users/gnome/dev/recolto-makina/content'
Error: ENOENT: no such file or directory, scandir '/Users/gnome/dev/recolto-makina/content'
- with "/" I had a working vitepress with a sidebar (including docs, README.md) but all individual pages were 404
- with "docs/content" I get a working sidebar only with the items in "content" + the pages, I assume that’s the expected result?
-> suggestion
| documentRootPath: 'content', | |
| documentRootPath: 'docs/content', |
There was a problem hiding this comment.
ok, my bad, my readme is not explicit enough 😬
You need to launch every commands in the docs folder.: cd docs. Then it should work properly
docs/content/sources-donnees.md
Outdated
| Actuellement, nous utilisons les données de Copernicus pour estimer les précipitations globales. Cependant, nous sommes en train de passer à l'API de Météo France afin d'améliorer la précision des données pluviométriques et de fournir des informations plus fiables adaptées à des lieux spécifiques. | ||
| - **estimation de la consommation d'eau mensuelle:** | ||
| Les calculs de consommation d'eau sont basés sur les statistiques nationales fournies par le Centre d'information sur l'eau, garantissant un reflet précis des habitudes de consommation. | ||
| - **calculer le prix de l'eau:** |
There was a problem hiding this comment.
| - **calculer le prix de l'eau:** | |
| - **calculer le prix de l'eau :** |
|
@CBalsier Thanks for the careful review! I have resolved all your typo suggestions. I let you close the remaining suggestions if it's ok for you. |
A first work for a documentation on ReadTheDocs built with Vitepress