Documentation is not rendering nicely
Miq1 opened this issue · 8 comments
Unfortunately, the HTML docs are not rendered nicely - all I could achieve is opening single HTML files to read them one by one. Am I missing something?
Plus, a picture of the look of all fonts would be a nice addition.
As a remedy, I found this tip on Stackoverflow. With it, the docs can be seen as
https://raw.githack.com/greiman/SSD1306Ascii/master/doc/html/class_s_s_d1306_ascii.html
You can got to the docs folder and click on this file.
Arduino/libraries/SSD1306Ascii/doc/SSD1306Ascii.htm
It opens the correct index file. and is better than the above.
I will add this to the README.md file.
What browser are you using? If I open SSD1306Ascii.html with chrome, firefox, edge, or explorer, I get the correct result.
You must open this in the local copy of the library.
Argh. My bad... 😊
I opened the file within the ZIP - after unpacking the structure into a proper directory tree it works out fine. Sorry for having bothered you!
I should have known. I plan to zip the html in the doc folders all my libraries in the future since they obscure the source changes with hundreds of changed html files. I am already doing this in SdFat.
I am amazed it partially worked. I am putting a single html file in the html folder with instructions to unzip html.zip and it replaces the html folder.
👍
Thanks a lot!