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

Docs fix #1244

Merged
merged 3 commits into from
Jan 17, 2023
Merged

Docs fix #1244

merged 3 commits into from
Jan 17, 2023

Conversation

Mason-McGough
Copy link
Contributor

Add the following fixes to documentation:

  • Fix trailing backslash in “Use docker image” section
  • Replace escaped backslash with double-escaped backslash (see Sphinx issue 6730)
  • Close backtick in contributing.md
  • Add “run” to instructions for “Render Video”
  • Remove unnecessary “,” in “Render Video”
  • Correct “before preceding” to “before proceeding”
  • Correct “viewpoinrts” to “viewpoints”
  • Add missing “.” in “Process data”
  • Specify “bash” for code blocks (for consistency with other blocks in the page)
  • Fix code block in viewer_quickstart.rst (”Copy to clipboard” widget now works)
  • Correct "harmoincs" to "harmonics"
  • Fix some code formatting issues in export_geometry.md (see below)

The fix to export_geometry.md is shown below for clarity:

Before:
image

After:
image

@Mason-McGough
Add the following fixes to documentation:
e444623 
* Fix trailing backslash in “Use docker image” section
* Replace escaped backslash with double-escaped backslash (see Sphinx issue: sphinx-doc/sphinx#6730)
* Close backtick in `contributing.md`
* Add “run” to instructions for “Render Video”
* Remove unnecessary “,” in “Render Video”
* Correct “before preceding” to “before proceeding”
* Correct “viewpoinrts” to “viewpoints”
* Add missing “.” in “Process data”
* Specify “bash” for code blocks (for consistency with other blocks in the page)
* Fix code block in `viewer_quickstart.rst` (”Copy to clipboard” widget now works)
* Fix some code formatting issues in `export_geometry.md`
@Mason-McGough
Correct "harmoincs" to "harmonics" in docs.
b405482
@Mason-McGough
Merge branch 'main' into docs-fix
505aff0
tancik
tancik approved these changes Jan 17, 2023
View reviewed changes
Copy link
Contributor

@tancik tancik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for going through the docs

@tancik tancik merged commit 92636c3 into nerfstudio-project:main Jan 17, 2023
@Mason-McGough Mason-McGough deleted the docs-fix branch January 17, 2023 17:45
tancik pushed a commit to dozeri83/nerfstudio that referenced this pull request Jan 20, 2023
@Mason-McGough @tancik
Docs fix (nerfstudio-project#1244)
b4d9f8d 
* Add the following fixes to documentation:

* Fix trailing backslash in “Use docker image” section
* Replace escaped backslash with double-escaped backslash (see Sphinx issue: sphinx-doc/sphinx#6730)
* Close backtick in `contributing.md`
* Add “run” to instructions for “Render Video”
* Remove unnecessary “,” in “Render Video”
* Correct “before preceding” to “before proceeding”
* Correct “viewpoinrts” to “viewpoints”
* Add missing “.” in “Process data”
* Specify “bash” for code blocks (for consistency with other blocks in the page)
* Fix code block in `viewer_quickstart.rst` (”Copy to clipboard” widget now works)
* Fix some code formatting issues in `export_geometry.md`

* Correct "harmoincs" to "harmonics" in docs.
lucasthahn pushed a commit to tne-ai/nerfstudio that referenced this pull request Jan 26, 2023
@Mason-McGough @lucasthahn
Docs fix (nerfstudio-project#1244)
c22f36c 
* Add the following fixes to documentation:

* Fix trailing backslash in “Use docker image” section
* Replace escaped backslash with double-escaped backslash (see Sphinx issue: sphinx-doc/sphinx#6730)
* Close backtick in `contributing.md`
* Add “run” to instructions for “Render Video”
* Remove unnecessary “,” in “Render Video”
* Correct “before preceding” to “before proceeding”
* Correct “viewpoinrts” to “viewpoints”
* Add missing “.” in “Process data”
* Specify “bash” for code blocks (for consistency with other blocks in the page)
* Fix code block in `viewer_quickstart.rst` (”Copy to clipboard” widget now works)
* Fix some code formatting issues in `export_geometry.md`

* Correct "harmoincs" to "harmonics" in docs.
chris838 pushed a commit to chris838/nerfstudio that referenced this pull request Apr 22, 2023
@Mason-McGough
Docs fix (nerfstudio-project#1244)
fb8a57d 
* Add the following fixes to documentation:

* Fix trailing backslash in “Use docker image” section
* Replace escaped backslash with double-escaped backslash (see Sphinx issue: sphinx-doc/sphinx#6730)
* Close backtick in `contributing.md`
* Add “run” to instructions for “Render Video”
* Remove unnecessary “,” in “Render Video”
* Correct “before preceding” to “before proceeding”
* Correct “viewpoinrts” to “viewpoints”
* Add missing “.” in “Process data”
* Specify “bash” for code blocks (for consistency with other blocks in the page)
* Fix code block in `viewer_quickstart.rst` (”Copy to clipboard” widget now works)
* Fix some code formatting issues in `export_geometry.md`

* Correct "harmoincs" to "harmonics" in docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tancik tancik tancik approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Mason-McGough @tancik