Comments (11)
I'd like to help with this. At first glance, most code is documented and would only need to set up Doxygen, is it correct?
from arduino.
That would be great! Setting up Doxygen is a good first step, code comments were greatly improved since I filed this request, but we'd have to inspect the output of Doxygen to see if any changes are necessary. My initial thought is adding a /docs/
directory for the Doxygen output is probably the simplest path and then I can enable github-pages pointing to that /docs/
directory as described here.
from arduino.
I've set up doxygen at the fork here: https://github.com/mexchip/arduino/tree/doxygen-docs
And also integrated into the fork's master to be able to set github pages as per the guide you suggested, so that you can have a look at how it looks: https://mexchip.github.io/arduino/
Please let me know what you think.
from arduino.
That was quick :D. For now we can set the readme as the main page. Looks like you can do that by setting USE_MDFILE_AS_MAINPAGE
to readme.md
in the Doxyfile as that referenced article author does in a later commit here.
Other than that this is a good start. I will override the css at some point to at least flatten the appearance of the header bar so it doesn't look so iPhone 2006 LoL.
from arduino.
Didn't know about that option! I've added it: https://mexchip.github.io/arduino/
Previously, I tried adding readme.md but had to add {#main_page} tag to current readme.md to make it appear on docs main page, but github doesn't hide those tags and it would appear in the repo main page too.
from arduino.
Other than that this is a good start. I will override the css at some point to at least flatten the appearance of the header bar so it doesn't look so iPhone 2006 LoL.
Yes, default doxygen style looks a bit outdated today 😝
from arduino.
I've added a .nojekyll file to fix doxygen generated html files that start with underscore not showing on github pages, as stated here: https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/
I also searched for some doxygen themes and applied this one: https://github.com/Velron/doxygen-bootstrapped
The problem with this doxygen theme it that it does not work with doxygen versions >=1.8.12 (Velron/doxygen-bootstrapped#20)
I generated the docs using doxygen 1.8.11 (had to compile it), I guess it'd be a problem whenever someone needs to rebuild the docs, what do you think?
from arduino.
Thanks for taking the time to look into alternate themes. However, I would like to avoid being constrained to a specific doxygen version just to have an alternate theme. Let's keep the default theme for now and I'll experiment with overriding the css and custom headers after your branch is merged.
from arduino.
Thanks for taking the time to look into alternate themes. However, I would like to avoid being constrained to a specific doxygen version just to have an alternate theme. Let's keep the default theme for now and I'll experiment with overriding the css and custom headers after your branch is merged.
Ok 👍
from arduino.
Thanks again for your help on this! Let me know if you think anything is missing documentation-wise. For example, I've been debating whether or not I should add the constants from FirmataConstants.h.
from arduino.
It was a pleasure!
I think constants should be added, so that they could be referenced in functions needing them as parameters.
from arduino.
Related Issues (20)
- Analog pin as digital. HOT 3
- Analog Pins on Constant Voltage HOT 1
- Additional Firmata Java library
- Inconsistent state for additional analog pins (A6 - A11) on Arduino Leonardo HOT 1
- Pyfirmata and arduino leonardo mouse and keyboard abilities HOT 2
- T HOT 1
- Error compiling for board Arduino Uno. HOT 1
- Error compiling Firmata for board Arduino Nano Every HOT 8
- Error when compiling StandardFirmata 2.5.8 for Ardbox Analog HF + Wifi from Industrialshields HOT 2
- broken link in readme.md
- Last released version is from 2018 despite a lot of new work being merged HOT 10
- How to change TX RX pin for Nano HOT 3
- To drive a Servo what Capabilities do i need from a board? HOT 2
- Ethernet server mode versus client mode HOT 1
- Arduino HOT 1
- Arduino Nano Every doesn't report A6 and A7 on StandardFirmata HOT 3
- add Arduino UNO R4 MINIMA to boards.h please HOT 11
- [Question] How to add support for Jolly-dev to StandardFirmataWiFi HOT 9
- Firmata for Raspberry Pi Pico HOT 1
- Problem compiling firmata for Giga R1 Wifi board 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 arduino.