Comments (5)
Thanks @hellekin! Looking at previous commits, it seems that it should be enough to change the .rst files. @haniavis could help on how you can build locally the documentation, but for simple changes you could already try a pull request directly changing the corresponding .rst file.
from guides.
Hi,
I just cleaned the repository from old build files.
This documentation is built using the Sphinx tool. So if you want to build locally the documentation, you should first clone the repo, then install sphinx in your machine and finally execute the following inside the guides folder:
sphinx-build -b html tech/source/ /your_output_folder/
Then you will be able to see the html files in your output folder.
Now in order to push these changes to the MAZI repository, you should fork the repository, optionally create another branch, make the changes and then create a pull request.
If you think that forking and creating a pull request is too much for this (probably), you can simply create another issue with your feedback and we will merge your feedback to the repository.
from guides.
I updated here the guidelines for contributors: https://github.com/mazi-project/guides/wiki/Contributing
Next step is to write guidelines for the contributors to the software code ...
from guides.
OK. I think there should be a Makefile to build the documentation, and the build/
directory should not be in the repository, only the sources. That would remove confusion... Maybe a Dockerfile could be there as well for people to preview the build without polluting their system with Sphinx dependencies.
from guides.
Hi @haniavis, I made #10 that should also close this issue.
from guides.
Related Issues (20)
- documentation on demo server outdated HOT 2
- Guidelines for typical Raspberry Pi accessories (USB storage, display) HOT 6
- Explain properly the two different types of wireless connectivity HOT 3
- Administration panel access HOT 6
- installing MAZI on different hardware
- update command copying image for linux HOT 1
- etherpad plugins / nextcloud applications HOT 2
- MAZI glossary definitions HOT 1
- MAZI glossary proposals HOT 1
- MAZI glossary proposals HOT 1
- password for nextcloud and interview admin page HOT 5
- Make clear what is optional in the "setting up a WiFi Access point" page
- post hashes on download page? HOT 1
- TL-MR3020 V3 – no OpenWRT Support? HOT 6
- Document meaning of fields output by Guestbook
- Update the expert guides for stretch HOT 2
- setup initial admin password does not work HOT 6
- Changing domain for wordpress not possible. HOT 1
- Raspberry Pi 4 support ? HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from guides.