Gordon Williams
5f0b776748
Fix "this is not available in \1" messages in reference
2025-09-12 08:43:36 +01:00
Gordon Williams
dd9d49cb10
Update docs so that we add links between more code snippets mentioning a function and the actual function
2024-10-25 14:59:07 +01:00
Gordon Williams
50249264b6
documentation tweaks
2024-10-25 14:20:02 +01:00
Gordon Williams
c1824f087b
Renumber Jolt.js Q connectors to be 0 based
2024-01-11 10:39:11 +00:00
Gordon Williams
e99e29552c
fix python version for doc builds
2024-01-08 16:23:07 +00:00
brenden adamczak
990667572b
removed markdown library for something newer
2023-12-13 07:43:21 -05:00
brenden adamczak
8878853e9a
seems to work with python3 now
2023-12-12 03:02:27 -05:00
Gordon Williams
138452fb65
Merging Dickens-specific changes into master
2023-09-27 14:57:47 +01:00
Gordon Williams
4ef8ce83f1
Fix making docs if unicode is in C files
2023-03-31 11:26:27 +01:00
Gordon Williams
e59b07a736
Improved document generation - and github links now point to that commit so the line numbers always match up
2022-07-28 15:32:46 +01:00
Gordon Williams
2344d53fc4
force python version
2022-07-26 12:18:21 +01:00
Gordon Williams
af8e933289
2v14 release
2022-06-09 15:43:50 +01:00
Gordon Williams
1eb760cadb
Handle !define in JSON #if fields - fixes docs
2022-01-11 13:23:12 +00:00
Gordon Williams
731e6107d8
Fix doc formatting (specifically intented lists)
2021-10-20 09:12:35 +01:00
Gordon Williams
cf76147a14
fix documentation formatting
2020-09-21 15:42:51 +01:00
Gordon Williams
15de460b31
Update showMenu docs to be more explicit, and remove duplicate entries in docs
2020-06-05 08:08:04 +01:00
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
