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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #6307

Merged
merged 23 commits into from
Aug 17, 2023
Merged

Improve documentation #6307

merged 23 commits into from
Aug 17, 2023

Commits on Aug 10, 2023

  1. Add install with upgrade option when installing latest development pa… 

    …ckage.
    @saurabheights
    saurabheights committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    2e8ee6d View commit details
    Browse the repository at this point in the history

  2. util/install-deps-python.sh was removed in isl-org#2146

    @saurabheights
    saurabheights committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    86e7a2f View commit details
    Browse the repository at this point in the history

Commits on Aug 11, 2023

  1. Grammar fix.

    @saurabheights
    saurabheights committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    3ea347d View commit details
    Browse the repository at this point in the history

  2. Move open3d_ml and arm to after docker.

    @saurabheights
    saurabheights committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    381882d View commit details
    Browse the repository at this point in the history

  3. organize TOC - Move C++ and Contribution to end and keep python secti… 

    …on together.
    @saurabheights
    saurabheights committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    17a27a3 View commit details
    Browse the repository at this point in the history

  4. Fix sphinx warnings (Title underline too short).

    @saurabheights
    saurabheights committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    0b8edfd View commit details
    Browse the repository at this point in the history

  5. Fix extra heading drop when going one level down.

    @saurabheights
    saurabheights committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    201b6bd View commit details
    Browse the repository at this point in the history

  6. Fix cross reference links

    @saurabheights
    saurabheights committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    5d798fd View commit details
    Browse the repository at this point in the history

Commits on Aug 12, 2023

  1. Add files/directories to ignore for sphinx, reduces inconsistency war… 

    …nings.
    @saurabheights
    saurabheights committed Aug 12, 2023
    Configuration menu
    Copy the full SHA
    42a1106 View commit details
    Browse the repository at this point in the history

  2. Fix Unknown directive type "code_block" warning.

    @saurabheights
    saurabheights committed Aug 12, 2023
    Configuration menu
    Copy the full SHA
    4c48feb View commit details
    Browse the repository at this point in the history

  3. Add uvmaps to official docs, fix - `WARNING: document isn't included … 

    …in any toctree`.
    @saurabheights
    saurabheights committed Aug 12, 2023
    Configuration menu
    Copy the full SHA
    9af3bdc View commit details
    Browse the repository at this point in the history

  4. Fix yaml lexer name - See https://pygments.org/languages/

    @saurabheights
    saurabheights committed Aug 12, 2023
    Configuration menu
    Copy the full SHA
    d71cd20 View commit details
    Browse the repository at this point in the history

  5. Correct the extension

    @saurabheights
    saurabheights committed Aug 12, 2023
    Configuration menu
    Copy the full SHA
    9c956d2 View commit details
    Browse the repository at this point in the history

  6. Fix warnings - `Inline substitution_reference start-string without en… 

    …d-string.`

This escapes vertical bars in bash tree output in pydocs but doesnt fix rendering in html.
    @saurabheights
    saurabheights committed Aug 12, 2023
    Configuration menu
    Copy the full SHA
    fb7c71c View commit details
    Browse the repository at this point in the history

Commits on Aug 13, 2023

  1. Minor code refactoring of make_docs.py

    @saurabheights
    saurabheights committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    c99fd1b View commit details
    Browse the repository at this point in the history

  2. Only copy open3d_tutorial.py once

    @saurabheights
    saurabheights committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    af3ba12 View commit details
    Browse the repository at this point in the history

Commits on Aug 14, 2023

  1. Move list of classes to a global variable

    @saurabheights
    saurabheights committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    04d8799 View commit details
    Browse the repository at this point in the history

  2. Use f-strings as requested in PR

    @saurabheights
    saurabheights committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    3d82438 View commit details
    Browse the repository at this point in the history

Commits on Aug 15, 2023

  1. Add python_api_in as ignored directory.

    @saurabheights
    saurabheights committed Aug 15, 2023
    Configuration menu
    Copy the full SHA
    549c739 View commit details
    Browse the repository at this point in the history

  2. Revert all changes made for correcting vertical bar in pydocs

    @saurabheights
    saurabheights committed Aug 15, 2023
    Configuration menu
    Copy the full SHA
    0d675cd View commit details
    Browse the repository at this point in the history

  3. Fix pybind docs with literal block for tree output

    @saurabheights
    saurabheights committed Aug 15, 2023
    Configuration menu
    Copy the full SHA
    a3cbf05 View commit details
    Browse the repository at this point in the history

  4. Fix doxygen docs with code block for tree output

    @saurabheights
    saurabheights committed Aug 15, 2023
    Configuration menu
    Copy the full SHA
    e807806 View commit details
    Browse the repository at this point in the history

  5. Correct class names in doxygen docs for RedWood dataset

    @saurabheights
    saurabheights committed Aug 15, 2023
    Configuration menu
    Copy the full SHA
    cfd570f View commit details
    Browse the repository at this point in the history