ESP8266 Community Forum

- Sat Nov 19, 2016 6:42 pm #58404 Hi all you experts,

for me as a newbee to Github and nodeMCU it is very hard to find the API
here http://nodemcu.readthedocs.io/en/master/

you wrote
"At the moment the only up-to-date documentation maintained by the current NodeMCU team is in English and hosted at http://nodemcu.readthedocs.io/. It is part of the source code repository (/docs subfolder), kept in sync with the code and built & published automatically.

if I clikc on the "english"-link I get here
http://nodemcu.readthedocs.io/en/master/en/

but there is nothing any more written about the API or how to get there.
What's so hard about providing a link to the subfolder /doc?

best regards

Stefan

- Sat Nov 19, 2016 6:50 pm #58405 OK took me some time to click around but finally found it
https://github.com/nodemcu/nodemcu-firm ... er/docs/en

It is a big time-saver that this kind of documentation can be created automatically.
For reading it it is much easier to have a single webpage or PDF-file.

Does there exist a tool that could create such a webpage or PDF-file.
Of course I can clone things from github on my local harddisc but then I still have to click back and forth through many many links to jump inside the documentation.

best regards

Stefan

- Sun Nov 20, 2016 7:59 am #58418 We're continuously looking for ways to improve our documentation (-> spend more time coding rather than with user support). However, I see little that could be done here.

https://github.com/nodemcu/nodemcu-firm ... umentation says it all. And once you arrive at http://nodemcu.readthedocs.io/en/master/en/ you see all modules listed in the navigation on the left.

A tiny improvement could be if we added an extra sentence about the modules to the "Getting Started" section there.

Does there exist a tool that could create such a webpage or PDF-file.

See https://github.com/nodemcu/nodemcu-firmware/issues/1073

https://frightanic.com/
https://nodemcu-build.com/
https://github.com/marcelstoer/nodemcu-pyflasher