NodeMCU 2.0 docs
Posted:
Tue Apr 11, 2017 6:51 amby cwr
Does anyone know how to build the NodeMCU docs from the current (dev) branch?
It looks as if they should build with MkDocs, but there's no Makefile target
and running "MkDocs build" produces a disconnected set of index.html files.
Thanks for any ideas - Will
Re: NodeMCU 2.0 docs
Posted:
Tue Apr 11, 2017 6:59 amby marcelstoer
Try 'mkdocs serve'. Otherwise you'd possibly need a local installation of Read The Docs - I never tried.
Re: NodeMCU 2.0 docs
Posted:
Wed Apr 12, 2017 4:59 amby marcelstoer
cwr wrote:running "MkDocs build" produces a disconnected set of index.html files.
Actually they're not disconnected. It's just that the navigation tree on the left is hidden. That's caused by
https://github.com/nodemcu/nodemcu-firm ... tra.js#L85 I believe the implementation of determineSelectedLanguageCode() simply didn't consider that use case.
Re: NodeMCU 2.0 docs
Posted:
Wed Apr 12, 2017 6:13 amby cwr
No, "mkdocs serve" apparently does nothing except start a server on a local port. In fact, the left-hand index comes up and shows the Overview correctly, but any attempt to use the index to reach other pages crashes out to the filesystem. The data is all there, and after kicking the html files around for a bit with sed I got a working set of references. I just wondered if there was an easier way, such as an updated MkDocs configuration file.
Will
Edit: it's easy when you know how - add "use_directory_urls: false" to the yml file.