Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fdomf/docs #1948

Merged
merged 14 commits into from Aug 1, 2019

Conversation

@fdomf
Copy link
Member

commented Jul 30, 2019

Description

Added c++ section to Read the Docs
Updated blueprint_library
Some updates on existing documentation

Where has this been tested?

  • Platform(s): Ubuntu 16.04
  • Python version(s): 2, 3
  • Unreal Engine version(s): ...

This change is Reviewable

@update-docs

This comment has been minimized.

Copy link

commented Jul 30, 2019

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would update our CHANGELOG.md based on your changes.

@fdomf fdomf self-assigned this Jul 30, 2019

@fdomf fdomf added the documentation label Jul 30, 2019

@fdomf fdomf requested review from bernatx and manishthani Jul 30, 2019

@bernatx bernatx added this to the 0.9.7 milestone Jul 31, 2019

@manishthani
Copy link
Contributor

left a comment

Reviewed 10 of 10 files at r1.
Reviewable status: all files reviewed, 10 unresolved discussions (waiting on @bernatx and @fdomf)


mkdocs.yml, line 21 at r1 (raw file):

  - 'Python API reference': 'python_api.md'
  - 'Blueprint Library': 'bp_library.md'
  - 'C++ reference' : 'c++_reference.md'

maybe the document filename could be cpp_reference.md ?


Docs/bp_library.md, line 5 at r1 (raw file):

The Blueprint Library ([`carla.BlueprintLibrary`](/python_api/#carlablueprintlibrary-class)) is a summary of all [`carla.ActorBlueprint`](/python_api/#carla.ActorBlueprint) and its attributes ([`carla.ActorAttribute`](/python_api/#carla.ActorAttribute)) available to the user in CARLA.  

Code used to print all actor blueprints and its attributes:  

Here is an example code for printing all actor blueprints and their attributes:


Docs/bp_library.md, line 14 at r1 (raw file):

Check our blueprint tutorial.

Check out our


Docs/c++_reference.md, line 9 at r1 (raw file):

[Unreal/CarlaUE4/Carla/Plugins](https://carla.org/Doxygen/html/dir_8fc34afb5f07a67966c78bf5319f94ae.html)

The documentation generated is available at this link **<https://carla.org/Doxygen/html/index.html>**

generated documentation


Docs/c++_reference.md, line 13 at r1 (raw file):

!!! note
    The documentation updates automatically with the github repository,
    so it will be always updated.

Looks a bit redundant, maybe this is more clear:
Document updates are done automatically by GitHub.


Docs/c++_reference.md, line 33 at r1 (raw file):

It will start to build the documentation webpage. Then go to Doxygen/html/ and open index.html in your browser.

I would try to explain better this process. Also, you could enumerate each step to make it simpler.


Docs/cameras_and_sensors.md, line 351 at r1 (raw file):

| ---------------------- | ----------- | ----------- |
| `frame`                | int         | Frame number when the measurement took place |
| `timestamp`            | double      | Timestamp of the measurement in simulation seconds since the beginning of the epispode |

episode


Docs/configuring_the_simulation.md, line 210 at r1 (raw file):

Also available:

The following options are also available with this command:


Docs/how_to_build_on_windows.md, line 21 at r1 (raw file):

- [Visual Studio](https://www.visualstudio.com/downloads/) (2017)

Make sure all the modules of the **requierements.txt** files are installed.

Make sure that all the modules specified in the requirements.txt file are installed.


Docs/index.md, line 25 at r1 (raw file):

  * [Python API reference](python_api.md)
  * [Blueprint Library](bp_library.md)
  * [C++ Reference](c++_reference.md)

cpp_reference.md

@fdomf
Copy link
Member Author

left a comment

Reviewable status: 2 of 10 files reviewed, 10 unresolved discussions (waiting on @bernatx and @manishthani)


mkdocs.yml, line 21 at r1 (raw file):

Previously, manishthani wrote…

maybe the document filename could be cpp_reference.md ?

Done.


Docs/bp_library.md, line 5 at r1 (raw file):

Previously, manishthani wrote…

Here is an example code for printing all actor blueprints and their attributes:

Done.


Docs/bp_library.md, line 14 at r1 (raw file):

Previously, manishthani wrote…

Check out our

Done.


Docs/cameras_and_sensors.md, line 351 at r1 (raw file):

Previously, manishthani wrote…

episode

Done.


Docs/configuring_the_simulation.md, line 210 at r1 (raw file):

Previously, manishthani wrote…

The following options are also available with this command:

Done.


Docs/how_to_build_on_windows.md, line 21 at r1 (raw file):

Previously, manishthani wrote…

Make sure that all the modules specified in the requirements.txt file are installed.

Done.


Docs/index.md, line 25 at r1 (raw file):

Previously, manishthani wrote…

cpp_reference.md

Done.


Docs/c++_reference.md, line 9 at r1 (raw file):

Previously, manishthani wrote…

generated documentation

Done.


Docs/c++_reference.md, line 13 at r1 (raw file):

Previously, manishthani wrote…

Looks a bit redundant, maybe this is more clear:
Document updates are done automatically by GitHub.

Done.


Docs/c++_reference.md, line 33 at r1 (raw file):

Previously, manishthani wrote…

I would try to explain better this process. Also, you could enumerate each step to make it simpler.

Done.

@manishthani
Copy link
Contributor

left a comment

Reviewed 7 of 8 files at r2, 1 of 1 files at r3.
Reviewable status: all files reviewed, 4 unresolved discussions (waiting on @bernatx and @fdomf)


mkdocs.yml, line 21 at r1 (raw file):

  - 'Python API reference': 'python_api.md'
  - 'Blueprint Library': 'bp_library.md'
  - 'C++ reference' : 'c++_reference.md'

C++ reference is ok.
I was referring only to the filename :)


Docs/index.md, line 25 at r1 (raw file):

  * [Python API reference](python_api.md)
  * [Blueprint Library](bp_library.md)
  * [C++ Reference](c++_reference.md)

change it here please


Docs/python_api_tutorial.md, line 444 at r3 (raw file):

Surrounding lane markings (right / left) can also be accessed through the waypoint API. Therefore it is possible to know all the information

Therefore,


Docs/c++_reference.md, line 2 at r1 (raw file):

<h1>C++ Reference </h1>

No need for changing that, C++ is better

@fdomf
Copy link
Member Author

left a comment

Reviewable status: all files reviewed, 4 unresolved discussions (waiting on @bernatx and @manishthani)


mkdocs.yml, line 21 at r1 (raw file):

Previously, manishthani wrote…

C++ reference is ok.
I was referring only to the filename :)

Right!


Docs/index.md, line 25 at r1 (raw file):

Previously, manishthani wrote…

change it here please

Done.


Docs/python_api_tutorial.md, line 444 at r3 (raw file):

Previously, manishthani wrote…

Therefore,

Done.


Docs/c++_reference.md, line 2 at r1 (raw file):

Previously, manishthani wrote…

No need for changing that, C++ is better

Done.

@manishthani
Copy link
Contributor

left a comment

Reviewed 4 of 4 files at r4.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @bernatx)

@bernatx
bernatx approved these changes Aug 1, 2019
Copy link
Member

left a comment

Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @bernatx)

@bernatx bernatx merged commit 3d7d293 into master Aug 1, 2019

4 checks passed

code-review/reviewable 10 files reviewed (bernatx)
Details
continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@delete-merged-branch delete-merged-branch bot deleted the fdomf/docs branch Aug 1, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
You can’t perform that action at this time.