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.

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

Jump to bottom

Fix links in documentation #68

Closed
wahn opened this issue Nov 15, 2018 · 8 comments
Closed

Fix links in documentation #68

wahn opened this issue Nov 15, 2018 · 8 comments
Assignees
@wahn
Labels
doc documentation

Comments

@wahn
Copy link
Owner

wahn commented Nov 15, 2018

I'm going to move the documentation to a new web page:

https://www.rs-pbrt.org/doc/crates/pbrt/index.html

There are some hardcoded paths to https://www.janwalter.org which have to be replaced by relative paths:

> rg -trust janwalter
src/lib.rs
18://! [here]: https://www.janwalter.org/doc/rust/pbrt/integrators/fn.render.html
19://! [render_bdpt]: https://www.janwalter.org/doc/rust/pbrt/integrators/bdpt/fn.render_bdpt.html
20://! [render_mlt]: https://www.janwalter.org/doc/rust/pbrt/integrators/mlt/fn.render_mlt.html

src/integrators/mod.rs
23://! ![Ambient Occlusion](https://www.janwalter.org/assets/cornell_box_pbrt_rust_ao.png)
33://! ![Direct Lighting](https://www.janwalter.org/assets/cornell_box_v0.1.13.png)
40://! ![Path Tracing](https://www.janwalter.org/assets/cornell_box_v0.2.0_high.png)
51://! Tracing](https://www.janwalter.org/assets/art_gallery_pbrt_rust_07n.png)

src/media/mod.rs
10://! ![A Volumetric Caustic](https://www.janwalter.org/assets/volume-caustic.png)

src/integrators/bdpt.rs
2177:/// ![bdpt](https://www.janwalter.org/assets/uml/pbrt/render_bdpt.png)

src/integrators/mlt.rs
390:/// ![bdpt](https://www.janwalter.org/assets/uml/pbrt/render_mlt.png)

src/cameras/mod.rs
18://! ![Perspective Camera](https://www.janwalter.org/assets/Perspectiva-2.png)

src/materials/mod.rs
21://! ![HairMaterial](https://www.janwalter.org/assets/hair_rust_pbrt.png)
25://! ![SubstrateMaterial](https://www.janwalter.org/assets/ganesha.png)

src/samplers/mod.rs
19://! ![halton](https://www.janwalter.org/assets/pbrt_rust_halton.png)
28://! ![random](https://www.janwalter.org/assets/pbrt_rust_random.png)
37://! ![sobol](https://www.janwalter.org/assets/pbrt_rust_sobol.png)
49://! ![lowdiscrepancy](https://www.janwalter.org/assets/pbrt_rust_lowdiscrepancy.png)
@wahn wahn added the doc documentation label Nov 15, 2018
@wahn wahn self-assigned this Nov 15, 2018
@wahn
Copy link
Owner Author

wahn commented Nov 15, 2018 •
edited

src/integrators/mod.rs done:

https://www.rs-pbrt.org/doc/crates/pbrt/integrators/index.html

diff --git a/pbrt/src/integrators/mod.rs b/pbrt/src/integrators/mod.rs
index 4857c50..ae78e4c 100644
--- a/pbrt/src/integrators/mod.rs
+++ b/pbrt/src/integrators/mod.rs
@@ -20,7 +20,7 @@
 //! whereas points with little geometry on the visible hemisphere
 //! appear light.
 //!
-//! ![Ambient Occlusion](https://www.janwalter.org/assets/cornell_box_pbrt_rust_ao.png)
+//! ![Ambient Occlusion](/doc/img/cornell_box_pbrt_rust_ao.png)
 //!
 //! ## Direct Lighting
 //!
@@ -30,14 +30,14 @@
 //! objects that are not themselfes emissive, except for basic
 //! specular reflection and transmission effects.
 //!
-//! ![Direct Lighting](https://www.janwalter.org/assets/cornell_box_v0.1.13.png)
+//! ![Direct Lighting](/doc/img/cornell_box_pbrt_rust_directlighting.png)
 //!
 //! ## Path Tracing
 //!
 //! Path tracing incrementally generates paths of scattering events
 //! starting at the camera and ending at light sources in the scene.
 //!
-//! ![Path Tracing](https://www.janwalter.org/assets/cornell_box_v0.2.0_high.png)
+//! ![Path Tracing](/doc/img/cornell_box_pbrt_rust_path.png)
 
 //! ## Bidirectional Path Tracing (BDPT)
 //!
@@ -48,7 +48,7 @@
 //! visibility ray.
 //!
 //! ![Bidirectional Path
-//! Tracing](https://www.janwalter.org/assets/art_gallery_pbrt_rust_07n.png)
+//! Tracing](/doc/img/art_gallery_pbrt_rust_bdpt.png)
 
 extern crate crossbeam;
 extern crate num_cpus;

@wahn
Copy link
Owner Author

wahn commented Nov 15, 2018

src/cameras/mod.rs done:

https://www.rs-pbrt.org/doc/crates/pbrt/cameras/index.html

diff --git a/pbrt/src/cameras/mod.rs b/pbrt/src/cameras/mod.rs
index 197b987..a2c3718 100644
--- a/pbrt/src/cameras/mod.rs
+++ b/pbrt/src/cameras/mod.rs
@@ -15,6 +15,6 @@
 //! object's dimensions along the line of sight are shorter than its
 //! dimensions across the line of sight.
 //!
-//! ![Perspective Camera](https://www.janwalter.org/assets/Perspectiva-2.png)
+//! ![Perspective Camera](/doc/img/wikipedia_perspective_camera.png)
 
 pub mod perspective;

@wahn
Copy link
Owner Author

wahn commented Nov 15, 2018

src/samplers/mod.rs done:

https://www.rs-pbrt.org/doc/crates/pbrt/samplers/index.html

diff --git a/pbrt/src/samplers/mod.rs b/pbrt/src/samplers/mod.rs
index 098a893..705bf30 100644
--- a/pbrt/src/samplers/mod.rs
+++ b/pbrt/src/samplers/mod.rs
@@ -16,7 +16,7 @@
 //! are simultaneously well distributed over all the dimensions of the
 //! sample vector.
 //!
-//! ![halton](https://www.janwalter.org/assets/pbrt_rust_halton.png)
+//! ![halton](/doc/img/cornell_box_pbrt_rust_halton.png)
 //!
 //! ## Random Sampler
 //!
@@ -25,7 +25,7 @@
 //! simple fast space-efficient statistically good algorithms for
 //! random number generation.
 //!
-//! ![random](https://www.janwalter.org/assets/pbrt_rust_random.png)
+//! ![random](/doc/img/cornell_box_pbrt_rust_random.png)
 //!
 //! ## Sobol Sampler
 //!
@@ -34,7 +34,7 @@
 //! vector. The weakness of the Sobol' points is that they are prone
 //! to structural grid artefacts before convergence.
 //!
-//! ![sobol](https://www.janwalter.org/assets/pbrt_rust_sobol.png)
+//! ![sobol](/doc/img/cornell_box_pbrt_rust_sobol.png)
 //!
 //! ## (0,2)-Sequence Sampler
 //!
@@ -46,7 +46,7 @@
 //! values for all of the pixel samples in the pixel are collectively
 //! well distributed.
 //!
-//! ![lowdiscrepancy](https://www.janwalter.org/assets/pbrt_rust_lowdiscrepancy.png)
+//! ![lowdiscrepancy](/doc/img/cornell_box_pbrt_rust_lowdiscrepancy.png)
 //!

 pub mod halton;

@wahn
Copy link
Owner Author

wahn commented Nov 15, 2018

src/integrators/mlt.rs done:

https://www.rs-pbrt.org/doc/crates/pbrt/integrators/mlt/fn.render_mlt.html

diff --git a/pbrt/src/integrators/mlt.rs b/pbrt/src/integrators/mlt.rs
index fc0b278..d7b9185 100644
--- a/pbrt/src/integrators/mlt.rs
+++ b/pbrt/src/integrators/mlt.rs
@@ -387,7 +387,7 @@ impl MLTIntegrator {
 /// **Main function** to **render** a scene multi-threaded (using all
 /// available cores) with **Metropolis Light Transport** (MLT).
 ///
-/// ![bdpt](https://www.janwalter.org/assets/uml/pbrt/render_mlt.png)
+/// ![bdpt](/doc/img/uml_pbrt_rust_render_mlt.png)
 pub fn render_mlt(
     scene: &Scene,
     camera: &Arc<Camera + Send + Sync>,

@wahn
Copy link
Owner Author

wahn commented Nov 15, 2018

src/integrators/bdpt.rs done:

https://www.rs-pbrt.org/doc/crates/pbrt/integrators/bdpt/fn.render_bdpt.html

diff --git a/pbrt/src/integrators/bdpt.rs b/pbrt/src/integrators/bdpt.rs
index c9db12e..471e25f 100644
--- a/pbrt/src/integrators/bdpt.rs
+++ b/pbrt/src/integrators/bdpt.rs
@@ -2174,7 +2174,7 @@ pub fn infinite_light_density<'a>(
 /// **Main function** to **render** a scene multi-threaded (using all
 /// available cores) with **bidirectional** path tracing.
 ///
-/// ![bdpt](https://www.janwalter.org/assets/uml/pbrt/render_bdpt.png)
+/// ![bdpt](/doc/img/uml_pbrt_rust_render_bdpt.png)
 pub fn render_bdpt(
     scene: &Scene,
     camera: &Arc<Camera + Send + Sync>,

@wahn
Copy link
Owner Author

wahn commented Nov 15, 2018

src/materials/mod.rs done:

https://www.rs-pbrt.org/doc/crates/pbrt/materials/index.html

diff --git a/pbrt/src/materials/mod.rs b/pbrt/src/materials/mod.rs
index 64244e8..b0a220f 100644
--- a/pbrt/src/materials/mod.rs
+++ b/pbrt/src/materials/mod.rs
@@ -18,11 +18,11 @@
 //!
 //! ## HairMaterial
 //!
-//! ![HairMaterial](https://www.janwalter.org/assets/hair_rust_pbrt.png)
+//! ![HairMaterial](/doc/img/hair_pbrt_rust.png)
 //!
 //! ## SubstrateMaterial
 //!
-//! ![SubstrateMaterial](https://www.janwalter.org/assets/ganesha.png)
+//! ![SubstrateMaterial](/doc/img/ganesha_pbrt_rust.png)
 
 pub mod fourier;
 pub mod glass;

@wahn
Copy link
Owner Author

wahn commented Nov 15, 2018

src/media/mod.rs done:

https://www.rs-pbrt.org/doc/crates/pbrt/media/index.html

diff --git a/pbrt/src/media/mod.rs b/pbrt/src/media/mod.rs
index 9f1fe32..7904a20 100644
--- a/pbrt/src/media/mod.rs
+++ b/pbrt/src/media/mod.rs
@@ -7,6 +7,6 @@
 //!
 //! ## Homogeneous Medium
 //!
-//! ![A Volumetric Caustic](https://www.janwalter.org/assets/volume-caustic.png)
+//! ![A Volumetric Caustic](/doc/img/volume_caustic_pbrt_rust_mlt.png)
 
 pub mod homogeneous;

@wahn
Copy link
Owner Author

wahn commented Nov 15, 2018

Finally:

diff --git a/pbrt/src/lib.rs b/pbrt/src/lib.rs
index c3b86d1..195264f 100644
--- a/pbrt/src/lib.rs
+++ b/pbrt/src/lib.rs
@@ -15,9 +15,9 @@
 //! [rust]: https://www.rust-lang.org/en-US
 //! [book]: http://www.pbrt.org
 //! [repo]: https://github.com/wahn/rs_pbrt
-//! [here]: https://www.janwalter.org/doc/rust/pbrt/integrators/fn.render.html
-//! [render_bdpt]: https://www.janwalter.org/doc/rust/pbrt/integrators/bdpt/fn.render_bdpt.html
-//! [render_mlt]: https://www.janwalter.org/doc/rust/pbrt/integrators/mlt/fn.render_mlt.html
+//! [here]: https://www.rs-pbrt.org/doc/crates/pbrt/integrators/fn.render.html
+//! [render_bdpt]: https://www.rs-pbrt.org/doc/crates/pbrt/integrators/bdpt/fn.render_bdpt.html
+//! [render_mlt]: https://www.rs-pbrt.org/doc/crates/pbrt/integrators/mlt/fn.render_mlt.html
 
 #[macro_use]
 extern crate hexf;

@wahn wahn closed this as completed Nov 15, 2018
wahn added a commit that referenced this issue Nov 15, 2018
@wahn
Fix links in documentation (see issue #68).
323a1ac
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wahn wahn

Labels
doc documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wahn