ESP8266 Community Forum

- Tue Apr 11, 2017 6:51 am #64825 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

- Tue Apr 11, 2017 6:59 am #64826 Try 'mkdocs serve'. Otherwise you'd possibly need a local installation of Read The Docs - I never tried.

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

- Wed Apr 12, 2017 4:59 am #64866

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.

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

- Wed Apr 12, 2017 6:13 am #64869 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.