Giter Club home page Giter Club logo

mylvglwatch's Introduction

A LVGL + TTGO T-Watch test with documentation

  1. Started by cloning RTD template: https://docs.readthedocs.io/en/stable/tutorial/ into github repository;
  2. Clone github repository to local directory;
  3. In the local copy: adapt conf.py (changed project name, author, ...);
  4. In the local copy: Remove lumache.py;
  5. In the local copy: create folder src, containing test source code;
  6. In the local copy: copy documentation (generated using exhale, breathe, doxygen and sphinx) into docs/source; - replaced index.rst and created/copied folder api;
  7. Add, commit, push;
  8. Deploy to RTD;

Result: The file hierarchy is accessed in https://mylvglwatch.readthedocs.io/en/latest/api/library_root.html# but the documentation embedded as comments in the source-code is not shown.

  1. Change conf.py to run breathe;
  2. add folder _doxygen and its contents;

Result: RTD compilation failed. It did not find breathe. Googled to a solution. Found: breathe-doc/breathe#89 and https://github.com/Cruel/readthedocs-breathe/tree/master/docs. Noticed that I missed file requirements.txt. Included it to my repo. It compiled and the source-code embedded documentation appeared.

mylvglwatch's People

Contributors

fnakano avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.