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.

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

Minor documentation fixes #135

Merged
merged 4 commits into from
Jan 27, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/source/_static/css/blockquote_custom1.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,30 @@ blockquote {
border-left: 0px solid #dddddd;
}


/* Override citation removing the left column for the BibTeX references*/
table.citation {
margin-left: 1px;
border-left: solid 1px white;
border-collapse: separate;
}

/* Fix BibTeX alignment */

.label {
display: block !important; /* fix citation misaligned */
}

/* Remove the colon from the copyright text in the footer */

.footer>.container>p:last-child {
visibility: hidden;
position: absolute;
margin-top: -20px;
}

.footer>.container>p:last-child:after {
content: ' © Copyright 2017-2018 The appleseedhq Organization';
visibility: visible;
}

18 changes: 14 additions & 4 deletions docs/source/bibtex/references.bib
Original file line number Diff line number Diff line change
Expand Up @@ -396,14 +396,24 @@ @article{Jakob:2014:CFR:2601097.2601139
keywords = {BRDF, BSDF, albedo problem, importance sampling, layered materials, linear transport theory},
}

@article{Boughida:2017:BCD,
author = {Malik Boughida and Tamy Boubekeur},
@article{Boughida:2017:BCD:3128450.3128464,
author = {Boughida, Malik and Boubekeur, Tamy},
title = {Bayesian Collaborative Denoising for Monte Carlo Rendering},
journal = {Computer Graphics Forum (Proc. EGSR 2017)},
journal = {Comput. Graph. Forum},
issue_date = {July 2017},
volume = {36},
number = {4},
month = {jul},
year = {2017},
issn = {0167-7055},
pages = {137--153},
year = {2017}
numpages = {17},
url = {https://doi.org/10.1111/cgf.13231},
doi = {10.1111/cgf.13231},
acmid = {3128464},
publisher = {The Eurographs Association \&\#38; John Wiley \&\#38; Sons, Ltd.},
address = {Chichester, UK},
keywords = {\'{z}Computing methodologies \'{z} Ray tracing, CCS Concepts, Image processing},
}

@inproceedings{dEon:2011:QMR:1964921.1964951,
Expand Down
20 changes: 10 additions & 10 deletions docs/source/features/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@
Features
********

Appleseed-maya is an appleseed plugin for Autodesk® Maya®.
appleseed-maya is an appleseed plugin for Autodesk® Maya®.

Main exporter features
======================

Presently the exporter supports:

* Rendering to Maya's RenderView
* Batch Rendering
* Appleseed project export (\*.appleseed files)
* Image Based Lighting via appleseed Physical Sky, and Dome Light
* Support for most of Maya's hypershade nodes (see :ref:`label_supported_nodes`)
* Several appleseed specific materials, texture, and utility nodes. See :ref:`Custom appleseed shader <label_shaders>` for detailed information.
* Shader overrides with diagnostic modes, ambient occlusion geometric information.
* Final render denoising :cite:`Boughida:2017:BCD`
* Support for custom OSL shaders as Maya shading nodes
* Rendering to Maya's RenderVie
* Batch Renderin
* Appleseed project export (\*.appleseed files)
* Image Based Lighting via appleseed Physical Sky, and Dome Light
* Support for most of Maya's hypershade nodes (see :ref:`label_supported_nodes`)
* Several appleseed specific materials, texture, and utility nodes. See :ref:`Custom appleseed shader <label_shaders>` for detailed information
* Shader overrides with diagnostic modes, ambient occlusion geometric information
* Final render denoising :cite:`Boughida:2017:BCD:3128450.3128464`
* Support for custom OSL shaders as Maya shading nodes

.. include:: limitations.rst

Expand Down
6 changes: 3 additions & 3 deletions docs/source/features/limitations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Limitations

Presently appleseed has the following limitations:

* Swatch rendering is limited to material nodes, not texture nodes.
* Swatch rendering is limited to material nodes, not texture nodes
* IPR is not supported yet
* XGen support is Work-In-Progress and is disabled in this release
* XGen support is work-in-progress and is disabled in this release
* Only meshes are exported and rendered right now
* `PTex <http://ptex.us/>`_ is not supported yet.
* `PTex <http://ptex.us/>`_ is not supported yet

.. seealso::
`appleseedhq GSoC 2017 Embree project <https://github.com/appleseedhq/appleseed/wiki/List-of-Project-Ideas-for-GSoC-2017#project-8-switch-to-embree>`_ if you're in a hurry for any of these features, or wish to contribute.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/installation/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The plugin is a Maya module.

**1.** Uncompress the zip file.

**2.** Add the path containing the appleseed-maya.mod file to your Maya.env [#]_ file or to the MAYA_MODULE_PATH environment variable.
**2.** Add the path containing the :file:`appleseed-maya.mod` file to your :file:`Maya.env` [#]_ file or to the :envvar:`MAYA_MODULE_PATH` environment variable.

**3.** Launch Maya and enable the plugin in the Plug-in Manager.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/shaders/shaders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Custom appleseed shaders
************************

These shaders are meant to either replace some of Maya's functionality that
wasn't possible to implement directly in `OSL <http://opensource.imageworks.com/?p=osl>`_, or to provide functionality
wasn't possible to implement directly in `OSL <https://github.com/imageworks/OpenShadingLanguage>`_, or to provide functionality
that is inexistent and we feel might be useful to the end user.

Procedural Texture Nodes
Expand Down
4 changes: 2 additions & 2 deletions docs/source/shaders/utilities/as_anisotropy_vector_field.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Field Parameters

*Field Mode*
The input anisotropy vector map can have the anisotropy directions along X and Y, encoded in the Red and Green channels, or in the Red and Blue channels.
Typically, RG encoding is used in applications such as PRman [#]_, while RB encoding is used in applications such as Modo [#]_ or Softimage [#]_.
Typically, RG encoding is used in applications such as RenderMan [#]_, while RB encoding is used in applications such as Modo [#]_ or Softimage [#]_.
The values allowed are therefore

* Red/Green as XY
Expand Down Expand Up @@ -84,7 +84,7 @@ Outputs

.. rubric:: Footnotes

.. [#] See PRman's `tangent field <https://rmanwiki.pixar.com/display/REN/PxrTangentField>`_ for details on PRman's implementation.
.. [#] See RenderMan's `tangent field <https://rmanwiki.pixar.com/display/REN/PxrTangentField>`_ for details on PRman's implementation.

.. [#] See `Modo anisotropy help <http://modo.docs.thefoundry.co.uk/modo/501/help/pages/shaderendering/ShaderItems/AnisotropicDirection.html>`_ for details on the Modo implementation. Unlike PRman's, the XY data is encoded in R and B channels, not R and G.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/shaders/utilities/as_falloff_angle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Outputs

.. seealso::

The `wikipedia page on smoothstep <https://en.wikipedia.org/wiki/Smoothstep>>`_ for more information.
The `wikipedia page on smoothstep <https://en.wikipedia.org/wiki/Smoothstep>`_ for more information.

-----

Expand Down
2 changes: 1 addition & 1 deletion docs/source/shaders/utilities/as_texture_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Outputs
A vector containing the minimum X and Y values of the pixel data window of the input texture, in the case of a 2D texture file. And the minimum X, Y and Z values of the pixel data window in the case of a 3D texture file.

*Data Window Maximum*
A vector containing the maximum X and Y values of the pixel data window of the input texture, in the case of a 2D texture file. And the minimum X, Y and Z values of the pixel data window in the case of a 3D texture file.
A vector containing the maximum X and Y values of the pixel data window of the input texture, in the case of a 2D texture file. And the maximum X, Y and Z values of the pixel data window in the case of a 3D texture file.

*Display Window Minimum*
A vector containing the minimum X and Y values of the full window of the image, in the case of a 2D texture file, and the minimum X, Y and Z values in the case of a 3D texture file.
Expand Down
8 changes: 0 additions & 8 deletions docs/source/tutorials/tutorial_3rd_party_applications.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/tutorials/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
:hidden:

tutorial_as_color_transform
tutorial_3rd_party_applications

*********
Tutorials
Expand All @@ -17,8 +16,3 @@ Working with Custom Nodes

* :ref:`asColorTransform Tutorial <label_tutorial_as_color_transform>`

Working with 3rd Party Applications
===================================

* :ref:`3rd Party Applications <label_tutorial_3rd_party_applications>`