-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Update docs #2658
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
Update docs #2658
Conversation
|
The main improvement to be done is to automate the docs build, that will prevent out-of-date docs at different places and save maintainer effort Without automating the doc build and deploy, I think it'll kind of defeat the entire point of having auto-generated docs from docstrings |
9a52506 to
f262b21
Compare
|
@madratman @saihv Could you have a look at this? Main addition here required is to enable automatic docs build using say Travis or Github Actions. I'm not sure as to what method is used currently, is it run |
6497e29 to
9eab0d0
Compare
|
Added a commit which runs a currently non-existent Maybe something like mkdocs/mkdocs#1082? I went for Travis instead of a Github Action since we also Sphinx in the mix to build the Python API docs |
873fe62 to
980e8b0
Compare
|
This will conflict with #2712, will be better to merge that first Travis setup needs to be looked at |
fc52c86 to
bb66d10
Compare
|
Moved Travis commits to #2749 |
|
/azp run microsoft.AirSim |
|
Commenter does not have sufficient privileges for PR 2658 in repo microsoft/AirSim |
|
/azp run microsoft.AirSim |
|
Azure Pipelines successfully started running 1 pipeline(s). |
594103c to
5636088
Compare
|
@madratman @saihv Is it possible to get this one merged anytime soon? The API reference would be very helpful for figuring out problems when using the Python APIs, and not require a deep-dive into the code to figure things out |
|
|
||
| mkdocs build | ||
|
|
||
| popd >/dev/null |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mkdocs and sphinx can't be run together due to a tornado version conflict b/w mkdocs and msgpack-rpc-python (needed for api docs)
I had therefore added a build_api_docs.sh in Pythonclient/ sometime back
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll copy generated api docs to a dir build_docs/ (not docs/)
pip install pymdown-extensionsI'm not quite sure as to how to link to the html page from the markdown files other than just having it in the nav bar and mentioning in the markdown to go to them through the github.io page nav bar. Better ways to add it to the docs are very much welcome
The 5th commit fixes the code-blocks and FAQs ordering in https://microsoft.github.io/AirSim/build_linux/, and numbering of steps in https://microsoft.github.io/AirSim/unreal_custenv/
It, however, causes the content of .uproject in the custom env page to be like the ones in the Linux build page. I thought it's okay considering it fixes the step numbering which I think is more imp
Let me know if I should change it back
Edit: The above is no longer a problem, the
extrasextension containssuperfenceswhich handles fenced codeblocks, and gives a nice-looking border around them, do test it out!Just using
build_docs.shand opening theindex.htmlfile will lead to links opening to the file server and not the html files directly. Runmkdocs serveto see how it will actually work