Skip to content

Commit 3d22bcc

Browse files
authored
docs: correctly refer to the readthedocs page for current docs (#2104)
I found some places that still referred to the old PDF document in the repo, but we haven't used that for a while and no longer build it. Also remove some chunks of the Makefile that used to be responsible for building the LaTeX docs, since those don't even exist in the repo any more. Signed-off-by: Larry Gritz <lg@larrygritz.com>
1 parent 6f2dfd1 commit 3d22bcc

File tree

2 files changed

+7
-41
lines changed

2 files changed

+7
-41
lines changed

README.md

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -480,21 +480,8 @@ how to build and install OSL.
480480
Documentation
481481
-------------
482482

483-
The OSL language specification can be found at
484-
[src/doc/osl-languagespec.pdf](src/doc/osl-languagespec.pdf) (in a source
485-
distribution) or in the share/doc/OSL/osl-languagespec.pdf file of an
486-
installed binary distribution.
487-
488-
[OSL Documentation on ReadTheDocs](https://docs.openshadinglanguage.org)
489-
This will be the future documentation. It's probably as complete as the PDF,
490-
but it needs some proofreading, so the PDF is still considered the
491-
authoritative source for now. But some time soon, the old PDF specification
492-
will be deprecated in favor of
493-
this online documentation.
494-
<!-- is the best place to start if you are interested in how to use OSL,
495-
its APIs. -->
496-
There is also a [PDF
497-
version](https://readthedocs.org/projects/open-shading-language/downloads/pdf/latest/).
483+
The OSL language specification can be found at [OSL Documentation on ReadTheDocs](https://docs.openshadinglanguage.org)
484+
There is also a [PDF version](https://readthedocs.org/projects/open-shading-language/downloads/pdf/stable/).
498485

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

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

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

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

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

569555

570556

571-
572557
Credits
573558
-------
574559

src/doc/Makefile

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,12 @@
22
# SPDX-License-Identifier: BSD-3-Clause
33
# https://github.com/AcademySoftwareFoundation/OpenShadingLanguage
44

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

6+
# by default, make the sphinx documentation
7+
all: doxygen sphinx
78

8-
# by default, just make the document
9-
all: languagespec.pdf
109

11-
12-
# document making rule: use pdflatex
13-
languagespec.pdf: *.tex Figures/*.pdf Figures/*png
14-
pdflatex ${PDFLATEX_FLAGS} languagespec.tex
15-
16-
17-
18-
# special command 'make index' to regenerate the index
19-
index: languagespec_index
20-
21-
languagespec_index:
22-
pdflatex ${PDFLATEX_FLAGS} languagespec.tex
23-
makeindex languagespec
24-
pdflatex ${PDFLATEX_FLAGS} languagespec.tex languagespec.aux macros.aux
25-
pdflatex ${PDFLATEX_FLAGS} languagespec.tex languagespec.aux macros.aux languagespec.toc
26-
27-
clean:
28-
rm -f languagespec.aux languagespec.idx languagespec.ilg languagespec.ind languagespec.log
29-
rm -f languagespec.out languagespec.pdf languagespec.toc macros.aux
10+
clean: doxygenclean
3011

3112
.PHONY: clean
3213

0 commit comments

Comments
 (0)