This is the repo for the atom-robotics-lab website, a documentation site for the our Projects. The wiki's purpose is to “Provide documentation for our project" - visit our wiki.
If you’re interested in helping to improve our wiki, find out how to contribute.
Our wiki »
Report Bug
·
Request Feature
Table of Contents
This is the repo for the atom-robotics-lab website, a documentation site for the our Projects. The wiki's purpose is to “Provide documentation for our project" - visit our wiki. If you’re interested in helping to improve our wiki, find out how to contribute.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- Sphinx
pip install sphinx
- Clone the repo
git clone git@github.com:atom-robotics-lab/wiki.git cd wiki
- To generate html files
Make html
- Open
_build/html/index.html
in your browser
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
- The
conf.py
file contains all the sphinx configuration. - All the
.rst
files are present in the/markdown
dir. - Custom html templates can be found in the
/_templates
dir.
- mdbook wiki
- Sphinx migration
- Fixing images sizes
- Shifting from .md to .rst
- Edit on wiki feature
- Collapsible sidebar menu
- Discarding use of Iframes
- Fixing local path links
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
For more info refer to contributing.md
Our Socials - Linktree - atom@inventati.org
Wiki Link: https://github.com/atom-robotics-lab/wiki