mitsuba3 icon indicating copy to clipboard operation
mitsuba3 copied to clipboard

Published 20 hours ago • verified publisher icon mitsuba-renderer

Documentation fixes

Open diiigle opened this issue 2 years ago • 3 comments

Some smaller improvements for the documentation:

  1. When reading the multijitter plugin documentation I stumbled upon an odd reference ("from Pixar" vs 1967). It seems like Google Scholar had a parsing issue there, and took an old Sobel reference that is in the pdf as the publication venue.

  2. I was missing the introduction of the "Flags" column for the plugin parameters. The hover feature is nice, but I still feel this topic is a bit sparsely covered. Also couldn't find any tutorials / guides sections that would shed some light on it either. Feel free to extend this.

Disclaimer: As I have no means of building the docs myself at the moment, I would advice for a manual check before merging this. I'm not too familiar with the reST syntax.

diiigle avatar Jul 27 '22 18:07 diiigle

Hi Tobias, What blocks you from building the documentation locally? It would indeed be good to double check before merging Delio

dvicini avatar Jul 29 '22 11:07 dvicini

I have written this PR with github.dev and I don't have all the required packages for building the docs in my docker container. I know from Tomas it's quite a hassle to setup.

diiigle avatar Jul 29 '22 15:07 diiigle

Okay. I get a warning when building the docs: mitsuba3/docs/zz_bibliography.rst:38: WARNING: missing booktitle in Kensler2013CorrelatedMS I think you should just change it to article instead of inproceedings.

Probably best if you setup the docs build and make sure it really works before we merge it :)

dvicini avatar Jul 29 '22 15:07 dvicini