Commit Graph

34 Commits

Author SHA1 Message Date
corkyw10 e786b9179a Updated PythonAPI with new WheelPhysicsControl values and Lidar/Semantic Lidar values. Fixed bug where 'inherited from' links were broken in API docs. Updated code snippet in tutorial 'control vehicle physics' 2021-05-20 16:33:27 +02:00
corkyw10 4233fe9310 Added information to alert the user that the 'Latest' version of the documentation points to branch and may show features that are not available in any packaged versions of carla as well as updated and improved docs 2021-03-15 15:43:15 +01:00
corkyw10 fe1472ca6e Add code snippets to Python API for toggling env objects and map layers. Corrected spelling of snippets on buttons and headers 2021-02-12 18:12:53 +01:00
Hamid Ebadi adb0e9f8ca
Converting html tags (table, image, link, etc.) into markdown (#3629)
* Converting html tags (table, image, link, etc.) into markdown, fixing an issue with python marrkdown generation script

* Converting tables for pandoc

* Incorrect code block

* Changelog is updated

Co-authored-by: Corinne <38050983+corkyw10@users.noreply.github.com>
Co-authored-by: Marc Garcia Puig <marcgpuig@gmail.com>
2020-12-14 13:15:32 +01:00
Marc Garcia Puig 6ad2610d33 Fixed docs 2020-11-24 16:57:51 +01:00
sergi-e 59e171a285 Fixed sorting lin ni gen_overview 2020-10-20 14:42:25 +02:00
sergi-e a00a97714b Fixed method sorting 2020-10-20 14:42:25 +02:00
sergi.e 31fff28bc6
sergi-e/api-snipets (#3409)
* First iteration with snipets, copy button and snippet button for all methods

* New iteration with snipets implemented and test snipets

* New iteration without yaml intervention, with auxiliary doc deleted and responsive buttons to window width

* New iteration with snipets copied from recipes, images added, and invisible button for small window

* Fixed some marging issues & code formatting

* Removed recipe reference and its instances. Snipets are now scalable to window width. Added button to close snipet. doc_gen_snipets.py is now imported in doc_gen.py. Cleaned css inside .py and added to extra.css

* New iteration with two functionalities for snipet buttons. Pop up for small windows.

* Fixed bp_library.md

Co-authored-by: Marc Garcia Puig <marcgpuig@gmail.com>
2020-10-15 16:48:48 +02:00
sergi-e c9e8c09b41 New fixes on M and D comments 2020-09-24 11:14:59 +02:00
sergi-e 935644d877 First iteration with units 2020-09-24 11:14:59 +02:00
sergi-e fd88d61aa7 Deleted links to CARLA versions after fixes to doc states 2020-05-08 13:51:04 +02:00
sergi-e bfec9d099e Little change in header text 2020-05-08 13:51:04 +02:00
sergi-e 361372d496 Changed links to docs build 2020-05-08 13:51:04 +02:00
sergi-e 564b7b9408 First iteration with getters, setters and previous APIs 2020-05-08 13:51:04 +02:00
sergi.e 239c4c5acd
sergi-e/p098-api (#2638)
* Python API iteration p098

* New order enum

* Fixed order getters setters

* New python api md

* New iteration, dunder coded

* PythonAPI/docs/doc_gen.py

* fix method_name
2020-03-30 10:18:13 +01:00
sergi.e eae903e908
sergi-e/sidebar-bug (#2529)
* Fix indexes for all the documentation.

* Added instructions for development assets in linux build

* Table bottom-margin workaround
2020-03-02 09:40:34 +01:00
sergi-e 386011dd96 Weird spacing fixed 2020-02-13 10:20:16 +01:00
sergi-e 22fc0c4be2 Added fix for index order 2020-02-13 10:20:16 +01:00
sergi-e 2570a31da0 Bug fixed index API 2020-02-13 10:20:16 +01:00
Francesc Domene 7e7f989606 Fdomf/docs (#2049)
* Updated CARLA video link (README)

* Updated API reference - deleted overview

* Added css to docs

* Added documentation standard section

* Updated API docs

* Updated documentation following the standard

* Updated How to create map and import docs + documentation related standard + improvements

* Word change

* Updated importing assests from RR

* Fixes and new section for pedestrian navigation

* Changed image position

* Updated
2019-09-06 11:07:21 +02:00
Francesc Domene ecff54faf5 Fdomf/docs (#1981)
* Added c++ doc section, Updated bp_library,docs improvements

* Minor changes

* Docs updates

* Added c++ doc section, Updated bp_library,docs improvements

* Minor changes

* Docs updates

* Updated jenkins file - master rebase

* Updated Jenkins - rebase

* Fixed doxygen link

* Waypoint tutorial extended and fixes

* Merge branch 'master' into fdomf/docs

* Fixes

* Merge branch 'fdomf/docs' of https://github.com/carla-simulator/carla into fdomf/docs

* Updated some python API class & methods

* Merge branch 'master' into fdomf/docs

* updated python api

* Updates

* Fixed broken link in camera&sensors doc

* Python API doc updated

* Added python api

* Added first lite version of python cookbook and docs related links

* Bp_doc_gen

* Merge branch 'master' into fdomf/docs

* merge master python api docs

* Updated doc

* make PythonApi.docs

* Merge branch 'master' into fdomf/docs

* Updated python API doc generator

* New debug recipe

* Docs fixes
2019-08-14 10:44:55 -07:00
Francesc Domene fb4a04b79d Added some more error checks in PythonApi docs generation 2019-07-09 19:18:46 +02:00
Marc Garcia Puig 88e9f7d128 Automated adding 'self' in class definitions 2019-07-09 19:18:46 +02:00
Marc Garcia Puig 0281b69dae Added inheritance in PythonAPI docs 2019-07-09 19:18:46 +02:00
Marc Garcia Puig a269f67447 Extended Map docs 2019-07-09 19:18:46 +02:00
Marc Garcia Puig 789c45d1a6 Auto-generated doc hyperlinks 2019-07-09 19:18:46 +02:00
Marc Garcia Puig cb67e26ef6 Added map docs & type info in instance variables 2019-07-09 19:18:46 +02:00
Marc Garcia Puig 1d46aadcd2 Make option for API Docs + added class Docs in MD 2019-07-09 19:18:46 +02:00
Marc Garcia Puig d6c955fd32 Better coloring 2019-07-09 19:18:46 +02:00
Marc Garcia Puig 8363b9757d Now docs are ordered alphabetically 2019-07-09 19:18:46 +02:00
Marc Garcia Puig caf0a93ce3 Added geom and map docs for python 2019-07-09 19:18:46 +02:00
Marc Garcia Puig 717477cc0e Improved Python doc generator 2019-07-09 19:18:46 +02:00
Marc Garcia Puig 80ba00d032 Improved PythonAPI docs generation 2019-07-09 19:18:46 +02:00
Marc Garcia Puig 8d3ea2ff1e Initial aproach to generate docs 2019-07-09 19:18:46 +02:00