Gordon Williams
e230148625
improve docs making
2019-11-07 16:12:27 +00:00
Gordon Williams
ea1f6e7020
Documentation for modules now includes require('...') in the call type to be less confusing
2019-09-12 12:42:58 +01:00
Gordon Williams
17849210bf
modify docs to put parameters/return value before the description
2019-02-11 09:36:28 +00:00
Gordon Williams
4f75809d3b
fix invalid hrefs pointed to by https://github.com/espruino/Espruino/issues/1498#issuecomment-430362451
2018-10-17 09:06:30 +01:00
Gordon Williams
348e38ffae
add keywords for classes and libraries
2018-09-07 14:00:17 +01:00
Gordon Williams
f717ceef5f
direct link to classes
2018-09-04 17:49:23 +01:00
Gordon Williams
3355a5bd9a
Now add links when a built-in function is referenced inside backticks
2018-09-04 13:28:59 +01:00
Gordon Williams
d7bb845725
better docs for I2C1/etc
2018-04-30 10:30:47 +01:00
Gordon Williams
24bfd5cede
Fix 'this is only available in' docs
2018-04-30 09:58:50 +01:00
Gordon Williams
9ffc516204
trying to bring WiFi docs/functions for Espruino in line on all platforms
2018-02-07 17:30:30 +00:00
Gordon Williams
f98105f338
fix links in docs
2017-08-03 09:29:37 +01:00
Gordon Williams
3206eecda5
fix https://github.com/espruino/EspruinoDocs/issues/361
2017-05-30 09:08:34 +01:00
Gordon Williams
0aa0a8aefb
fix #1145
2017-04-19 13:30:37 +01:00
Gordon Williams
c363065328
fix docs when example code has odd characters in the title
2017-03-16 13:11:36 +00:00
Gordon Williams
4d0567ef05
remove needless script tags
2017-03-02 15:52:27 +00:00
Gordon Williams
2680d05f2f
tweaking HTML output
2017-03-02 14:40:08 +00:00
Gordon Williams
8d85c992d5
fix regression in doc creation
2017-01-17 09:33:32 +00:00
Gordon Williams
5caa4c2905
Adding Global built-in objects like SPI1/Serial1 and Bluetooth to the docs
2017-01-09 11:26:49 +00:00
Gordon Williams
0de8965423
make docs nicer for 'Note' about it not being in all devices
2017-01-05 18:36:46 +00:00
Gordon Williams
8ce721b00a
more docs tweaks
2016-11-09 14:34:15 +00:00
Gordon Williams
7c7e3ac32d
update docs, and finally use a proper markdown parser!
2016-11-09 14:19:40 +00:00
Gordon Williams
f9fdd62f88
attempt at improving HTML documentation quality
2016-10-18 09:49:31 +01:00
Gordon Williams
4410817bd7
Put links to C declarations of functions in the reference ( fix #849 )
2016-04-27 10:35:07 +01:00
Gordon Williams
a2fb33f01a
Add the ability to set clock frequencies on STM32F4 chips (like Pico) with E.setClock ( fix #52 )
2016-03-11 10:57:52 +00:00
allObjects
1a3784e825
reinstating href anchor for all reference links
...
Changes to be committed:
modified: scripts/build_docs.py
2015-11-24 22:32:40 -08:00
Gordon Williams
ac7724649b
improve docs - report libraries as libraries, sort regardless of case
2015-11-24 14:35:41 +00:00
Gordon Williams
1cb14c6f0a
fix title links that got broken after PR
2015-11-24 14:22:27 +00:00
allObjects
ee57ca4f70
Re-instated url update with anchor name
...
Changes to be committed:
modified: scripts/build_docs.py
2015-11-23 10:20:54 -08:00
allObjects
a449291055
enhanced navigation in reference page
...
- added backlinks from detail headers to (table of) content entries
- enhanced #top link to select searchbox entry and focus on it
- made navigation jumps (former anchorlinks) to postion at 20% of view port
- made completed navigation jump to blush blue on back and gold on forward
- added htmldev development mode flag to develop and test in standalone mode
Changes to be committed:
modified: scripts/build_docs.py
2015-11-21 21:10:06 -08:00
Neil Kolban
d322cc7d67
Change print "XXX" to print("XXX")
...
Change the python scripts to add parenthesis to print statements.
2015-08-27 14:19:19 -05:00
Gordon Williams
cfda8a5d04
remove debug print stuff
2015-08-07 11:24:56 +01:00
Gordon Williams
5db662db8e
try and improve handling of lists - should really just use a proper markdown parser :)
2015-08-07 10:50:51 +01:00
Gordon Williams
10ba9f71d0
add other bits of markdown
2015-02-19 15:06:34 +00:00
Gordon Williams
701a98056e
better markdown formatting
2015-01-29 12:41:12 +00:00
Gordon Williams
4c0a5db7e3
script to refactor Espruino's formatted comments
2014-09-10 18:21:07 +01:00
Gordon Williams
1657f46814
add links to MDN for functions that are covered
2014-07-16 09:32:43 +01:00
Gordon Williams
c15c55dfe2
updated docs to help tern determine what objects are returned
2014-07-15 17:23:01 +01:00
Gordon Williams
199444b86c
make reference doc aware of a 'references.json' file
2014-07-15 16:32:23 +01:00
Gordon Williams
b3de0eac40
Move Serial.onData(...) to Serial.on('data',...)
...
Add Serial.read/available/pipe (fix #383 )
Add HTTP client/server read/available/pipe
Add documentation for events (and tidy it up for constructors)
2014-06-19 14:50:43 +01:00
Gordon Williams
f85bbd0124
doc fix
2014-05-20 12:47:03 +01:00
Gordon Williams
0fc9fcb2f8
update http docs - fix EspruinoDocs/#74
2014-05-19 08:22:14 +01:00
Gordon Williams
6cbf50ed66
add spi/i2c/etc links
2014-05-08 16:29:42 +01:00
Gordon Williams
8538c69803
Improve auto-generated documentation
2014-02-26 08:49:15 +00:00
Gordon Williams
4ec13c9fa9
setWatch now reports lastTime - time of last state change #238
2014-02-14 12:45:40 +00:00
Gordon Williams
a1e08e97bd
Misc tweaks to provide info that was handle for the new Web IDE
2013-11-14 16:11:10 +00:00
Gordon Williams
7e39506542
Allow built-in functions with variable numbers of arguments ( fix #83 )
2013-10-21 18:01:58 +01:00
Gordon Williams
3d409c41a0
Now build keywords list
2013-10-14 20:32:54 +01:00
Gordon Williams
7e9532b898
'http' and 'fs' are now libraries that need to be 'require'd, fix #8
2013-10-10 19:58:47 +01:00
Gordon Williams
f3d6e0bc83
First commit
2013-09-26 14:39:04 +01:00
