Skip to content

Documentation - #13

Merged
tjueterb merged 11 commits into
masterfrom
documentation
Aug 18, 2026
Merged

tjueterb merged 11 commits into
masterfrom
documentation

Conversation

@tjueterb

@tjueterb tjueterb commented Jul 29, 2026

Copy link
Copy Markdown
Member

Description

Note on the PyPI variants box. The variant set the wheel ships is not settled yet. Once it is, four places have to agree:

  • .github/workflows/wheels.yml, the VARIANTS env var, which today lists the stock upstream optical variants and no *_acoustic ones
  • README.md, the variant list under Installation
  • docs/index.rst, the Installation section
  • docs/src/key_topics/acoustics.rst, the paragraph on what the pip package ships

This will be updated after this PR.

Checklist

  • Add a section in emitters about the difference between our emitters and the receiver spheres in ease / RAVEN. reference that in acoustics.rst
  • Link the mitsuba 3 how to guides
  • Open external links in new tabs (key_topics.rst and sidebar)
  • check if the uniform spectrum docstring is correct (are wavelength_min /max actually used?)
  • section_spectra: reorder code tabs so acoustic variants come first)
  • reorder code tabs so python is open by default instead of xml
  • update documentation where the XML format is described instead of python
  • fix backend description in acoustic_rendering.rst
  • Update compilation instructions (Add instructions for venv/uv?) and how to source setpath.sh from the activation stript?)
  • link to mitsuba docs v3.9.1 (will update the base version after this PR)
  • reword area emitter docstring to make it compatible with acoustics
  • Update key topics page
  • Update usage instructions (e.g. make sure that it lists how to make libLLVM available on mac)
  • remove banners
  • fix venv guide (stray windows only steps in prose)
  • Add conda instructions to the venv guide
  • My code follows the style guidelines of this project
  • My changes generate no new warnings
  • My code also compiles for cuda_* and llvm_* variants. If you can't test this, please leave below
  • I have made corresponding changes to the documentation
  • I have added my changes to docs/release-notes.rst
  • I cleaned the commit history and removed any "Merge" commits
  • I grant the misuka project permission to redistribute, relicense, and sublicense my contributions under the project's current or future license, including licenses that permit commercial use

@tjueterb
tjueterb force-pushed the documentation branch 3 times, most recently from 2617bcf to 20dd8b9 Compare July 29, 2026 14:59
@tjueterb tjueterb added this to the misuka v0.1.0 milestone Jul 30, 2026
@tjueterb tjueterb self-assigned this Jul 30, 2026
@tjueterb
tjueterb force-pushed the documentation branch 6 times, most recently from 3bafacb to 5fd53a8 Compare July 31, 2026 15:41
@tjueterb tjueterb added the documentation Improvements or additions to documentation label Aug 3, 2026
@tjueterb
tjueterb force-pushed the documentation branch 2 times, most recently from 6f19a3d to 8ca4773 Compare August 17, 2026 15:22
@tjueterb
tjueterb marked this pull request as ready for review August 17, 2026 16:34
@tjueterb
tjueterb merged commit 810f8b7 into master Aug 18, 2026
@tjueterb
tjueterb deleted the documentation branch August 18, 2026 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant