Skip to content

docs: correctly refer to the readthedocs page for current docs #2104

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

Merged
lgritz merged 1 commit into from
Apr 4, 2026
+7 −41
Merged

docs: correctly refer to the readthedocs page for current docs #2104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 4 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,21 +480,8 @@ how to build and install OSL.
Documentation
-------------

The OSL language specification can be found at
[src/doc/osl-languagespec.pdf](src/doc/osl-languagespec.pdf) (in a source
distribution) or in the share/doc/OSL/osl-languagespec.pdf file of an
installed binary distribution.

[OSL Documentation on ReadTheDocs](https://docs.openshadinglanguage.org)
This will be the future documentation. It's probably as complete as the PDF,
but it needs some proofreading, so the PDF is still considered the
authoritative source for now. But some time soon, the old PDF specification
will be deprecated in favor of
this online documentation.
<!-- is the best place to start if you are interested in how to use OSL,
its APIs. -->
There is also a [PDF
version](https://readthedocs.org/projects/open-shading-language/downloads/pdf/latest/).
The OSL language specification can be found at [OSL Documentation on ReadTheDocs](https://docs.openshadinglanguage.org)
There is also a [PDF version](https://readthedocs.org/projects/open-shading-language/downloads/pdf/stable/).

For those interested in learning to program OSL shaders there is the
[Siggraph 2024 Course](https://dl.acm.org/doi/proceedings/10.1145/3664475),
Expand Down Expand Up @@ -559,16 +546,14 @@ Contacts, Links, and References

[OSL GitHub page](https://github.com/AcademySoftwareFoundation/OpenShadingLanguage)

[Read or subscribe to the OSL development mail list](https://lists.aswf.io/g/osl-dev)
[OSL Documentation on ReadTheDocs](https://docs.openshadinglanguage.org)

[Most recent PDF of the OSL language specification](https://github.com/AcademySoftwareFoundation/OpenShadingLanguage/blob/main/src/doc/osl-languagespec.pdf
)
[Read or subscribe to the OSL development mail list](https://lists.aswf.io/g/osl-dev)

[OSL home page](http://openshadinglanguage.org)




Credits
-------

Expand Down
25 changes: 3 additions & 22 deletions src/doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,12 @@
# SPDX-License-Identifier: BSD-3-Clause
# https://github.com/AcademySoftwareFoundation/OpenShadingLanguage

PDFLATEX_FLAGS = -interaction=errorstopmode ### "--shell-escape"

# by default, make the sphinx documentation
all: doxygen sphinx

# by default, just make the document
all: languagespec.pdf


# document making rule: use pdflatex
languagespec.pdf: *.tex Figures/*.pdf Figures/*png
pdflatex ${PDFLATEX_FLAGS} languagespec.tex



# special command 'make index' to regenerate the index
index: languagespec_index

languagespec_index:
pdflatex ${PDFLATEX_FLAGS} languagespec.tex
makeindex languagespec
pdflatex ${PDFLATEX_FLAGS} languagespec.tex languagespec.aux macros.aux
pdflatex ${PDFLATEX_FLAGS} languagespec.tex languagespec.aux macros.aux languagespec.toc

clean:
rm -f languagespec.aux languagespec.idx languagespec.ilg languagespec.ind languagespec.log
rm -f languagespec.out languagespec.pdf languagespec.toc macros.aux
clean: doxygenclean

.PHONY: clean

Expand Down
Loading