687vex / NerdyLib-Docs

The official documentation for NerdyLib

NerdyLib-Docs

The official documentation for NerdyLib

Built With

• Python 3:
  • sphinx
  • furo
    • myst-parser
    • sphinx-favicon
  • pipenv
• Visual Studio Code

How to Use NerdyLib-Docs

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Working Python 3 >= 3.10.4 installation

  • pip is working

• Visual Studio Code

  • MyST-Markdown Extension
  • Python Extension

Installation

1. Clone the repo

   git clone https://github.com/687vex/NerdyLib-Docs.git

2. Upgrade pip

   pip install --upgrade pip

3. Install/update project requirments (administrator permissions may be required)

   pip install -r requirements.txt

Development Server

1. Move to the root directory:

   cd NerdyLib-Docs

2. Run the live server:

   sphinx-autobuild source build

   When a change is detected in source/, the documentation is rebuilt and any open browser windows are reloaded automatically. KeyboardInterrupt (ctrl+c) will stop the server.
3. Open the browser to view the local server:

   http://localhost:8000/

Structure

• docs/index.rst - index file (written in reStructuredText)
• docs/*.md - myST markdown files (new ones should be added to the index.rst table of contents)
• docs/conf.py - site configuration (only modified when absolutely necessary)

Contributing

Contributions are always welcome! Please create a Pull Request and include a description of how your Pull Request will improve the overall robot code and what it does.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the TBD License. See LICENSE.txt for more information.

Support Us!

Give this repo a ⭐️ if you found this project helpful!

Acknowledgments

• othneildrew's Best README Template
• PROS 3 Documentation
• Sphinx Documentation
• Pipenv Documentation
• GitHub Pages with Python Sphinx
• Documentation formatting heavily inspired by DeepwaterExploration/DeepwaterExplorationDocs