Nasal api doc.py: Difference between revisions
(https://forum.flightgear.org/viewtopic.php?f=71&t=31470&p=305773#p305773) |
m (Partial copy editing; +-cat: Python Software → Python software) |
||
(7 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
{{Stub}} | {{Stub}} | ||
There is a Python script that parses $FG_ROOT/Nasal to create up-to-date Nasal docs from it. See Adrian's script: [https://forum.flightgear.org/viewtopic.php?f=72&t=25119 viewtopic.php?f=72&t=25119]<ref>{{cite web | |||
|url = https://forum.flightgear.org/viewtopic.php?p=286012#p286012 | |||
|title = <nowiki> Re: </nowiki> | |||
|author = <nowiki> Hooray </nowiki> | |||
|date = May 21st, 2016 | |||
|added = May 21st, 2016 | |||
|script_version = 0.40 | |||
}}</ref> | |||
There is a dedicated Python script that can help automatically extract most of the boilerplate structure to help create the wiki stub. See Adrian's work.<ref>{{cite web | |||
|url = https://forum.flightgear.org/viewtopic.php?p=304161#p304161 | |||
|title = <nowiki> Re: Canvas GUI API documentation in wiki </nowiki> | |||
|author = <nowiki> Hooray </nowiki> | |||
|date = Jan 25th, 2017 | |||
|added = Jan 25th, 2017 | |||
|script_version = 0.40 | |||
}}</ref> | |||
Adrian came up with a simple Nasal API file for $FG_ROOT/Nasal using a python script. He uploaded the file [http://ompldr.org/vY2hmYw/nasal_api.html here]. | |||
Adrian's python script automatically creates Nasal API docs based on parsing $FG_ROOT/Nasal.<ref>{{cite web | |||
|url = https://forum.flightgear.org/viewtopic.php?p=150191#p150191 | |||
|title = <nowiki> Re: </nowiki> | |||
|author = <nowiki> Hooray </nowiki> | |||
|date = Feb 11th, 2012 | |||
|added = Feb 11th, 2012 | |||
|script_version = 0.40 | |||
}}</ref> | |||
Adrian's nasal_api_doc.py script in $FG_SRC/scripts/python should automatically create updated API documentation based on the nasal source code in $FG_ROOT/Nasal (HTML output).<ref>{{cite web | |||
|url = https://forum.flightgear.org/viewtopic.php?p=177299#p177299 | |||
|title = <nowiki> Re: Canvas API documentation </nowiki> | |||
|author = <nowiki> Hooray </nowiki> | |||
|date = Feb 15th, 2013 | |||
|added = Feb 15th, 2013 | |||
|script_version = 0.40 | |||
}}</ref> | |||
This is a temporary solution until there is a more solid solution. The reasons Adrian used a home made parser instead of a pre-made solution is the lack of uniform coding and comment style. There is for sure a lot to be improved. For one, Adrian would like to extend it further so it can parse classes as well. | |||
Please take a look and comment.<ref>{{cite web | |||
|url = https://forum.flightgear.org/viewtopic.php?p=148751#p148751 | |||
|title = <nowiki> </nowiki> | |||
|author = <nowiki> adrian </nowiki> | |||
|date = Jan 27th, 2012 | |||
|added = Jan 27th, 2012 | |||
|script_version = 0.40 | |||
}}</ref> | |||
== References == | |||
{{Appendix}} | |||
[[Category:Nasal]] | |||
[[Category:Python software]] |
Latest revision as of 09:28, 25 March 2020
This article is a stub. You can help the wiki by expanding it. |
There is a Python script that parses $FG_ROOT/Nasal to create up-to-date Nasal docs from it. See Adrian's script: viewtopic.php?f=72&t=25119[1]
There is a dedicated Python script that can help automatically extract most of the boilerplate structure to help create the wiki stub. See Adrian's work.[2]
Adrian came up with a simple Nasal API file for $FG_ROOT/Nasal using a python script. He uploaded the file here.
Adrian's python script automatically creates Nasal API docs based on parsing $FG_ROOT/Nasal.[3]
Adrian's nasal_api_doc.py script in $FG_SRC/scripts/python should automatically create updated API documentation based on the nasal source code in $FG_ROOT/Nasal (HTML output).[4]
This is a temporary solution until there is a more solid solution. The reasons Adrian used a home made parser instead of a pre-made solution is the lack of uniform coding and comment style. There is for sure a lot to be improved. For one, Adrian would like to extend it further so it can parse classes as well.
Please take a look and comment.[5]
References
References
|