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

More doc reorg #1335

Merged
merged 5 commits into from
Feb 19, 2023
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
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ correctness and verifiability, and breadth of adoption. Imath is not
intended to be a comprehensive linear algebra or numerical analysis
package.

# Project Governance
## Project Governance

OpenEXR is a project of the [Academy Software
Foundation](https://www.aswf.io). See the project's [governance
Expand Down Expand Up @@ -127,14 +127,14 @@ API](https://openexr.readthedocs.io/en/latest/API.html#the-openexr-api).

- Email to security@openexr.com

* **Make a contribution:**
* **Contribute a Fix, Feature, or Improvement:**

- Read the [contribution guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md)
- Read the [Contribution Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md)

- Sign the [contributor license
agreement](https://contributor.easycla.lfx.linuxfoundation.org/#/cla/project/2e8710cb-e379-4116-a9ba-964f83618cc5/user/564e571e-12d7-4857-abd4-898939accdd7)
- Sign the [Contributor License
Agreement](https://contributor.easycla.lfx.linuxfoundation.org/#/cla/project/2e8710cb-e379-4116-a9ba-964f83618cc5/user/564e571e-12d7-4857-abd4-898939accdd7)

- Submit a PR: https://github.com/AcademySoftwareFoundation/openexr/pulls
- Submit a Pull Request: https://github.com/AcademySoftwareFoundation/openexr/pulls

# Resources

Expand Down
8 changes: 4 additions & 4 deletions docs/PortingGuide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -314,14 +314,14 @@ If your application code reports compile errors due to undefined or
incompletely-defined Imath or OpenEXR data types, locate the Imath or
OpenEXR header file that defines the type and include it explicitly.

## Symbols Are Hidden by Default
Symbols Are Hidden by Default
=============================

To reduce library size and make linkage behavior similar across
platforms, Imath and OpenEXR now build with directives that make
symbol visibility hidden by default, with specific externally-visible
symbols explicitly marked for export. See the [Symbol
Visibility](https://github.com/AcademySoftwareFoundation/openexr/blob/main/docs/SymbolVisibility.md)
doc and the appropriate ``*Export.h`` header file for more details.
symbols explicitly marked for export. See the :doc:`SymbolVisibility`
and the appropriate ``*Export.h`` header file for more details.

Imath Now Uses Standard C++ Exceptions and ``noexcept``
=======================================================
Expand Down
6 changes: 6 additions & 0 deletions docs/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ About OpenEXR
.. toctree::
:caption: About

.. sidebar::

.. image:: images/OpenEXR_Reel_2020.png
:target: https://www.youtube.com/embed/X0khNMmEJEI
:width: 325

OpenEXR is a project of the `Academy Software Foundation
<https://www.aswf.io>`_. The format and library were originally
developed at Industrial Light & Magic and first released as open
Expand Down
3 changes: 1 addition & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,13 +171,12 @@

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "images/openexr-stacked-color.png"
html_logo = "images/openexr-horizontal-color.png"

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
html_favicon = "images/openexr-fav.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
Binary file added docs/images/OpenEXR_Reel_2020.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/openexr-fav.ico
Binary file not shown.
11 changes: 7 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,16 @@ Community

- Email security@openexr.com

* **Make a contribution:**
* **Contribute a Fix, Feature, or Improvement:**

- Read the `Contribution guidelines <https://github.com/AcademySoftwareFoundation/openexr/blob/main/CONTRIBUTING.md>`_
- Read the `Contribution guidelines
<https://github.com/AcademySoftwareFoundation/openexr/blob/main/CONTRIBUTING.md>`_
and `Code of Conduct <https://github.com/AcademySoftwareFoundation/openexr/blob/main/CODE_OF_CONDUCT.md>`_

- Sign the `Contributor License Agreement
<https://contributor.easycla.lfx.linuxfoundation.org/#/cla/project/2e8710cb-e379-4116-a9ba-964f83618cc5/user/564e571e-12d7-4857-abd4-898939accdd7>`_

- Submit a PR: https://github.com/AcademySoftwareFoundation/openexr/pulls
- Submit a Pull Request: https://github.com/AcademySoftwareFoundation/openexr/pulls

Resources
=========
Expand All @@ -91,6 +93,7 @@ Resources
- Release notes: `CHANGES.md
<https://github.com/AcademySoftwareFoundation/openexr/blob/main/CHANGES.md>`_
- Contributors: `CONTRIBUTORS.md <https://github.com/AcademySoftwareFoundation/openexr/blob/main/CONTRIBUTORS.md>`_

- Porting Guide: :doc:`PortingGuide`

.. include:: toc_redirect.rst

Loading