diff --git a/docs/index.md b/docs/index.md index ac01461e9..59d7411b5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,7 +26,7 @@ header file contains a single function (e.g. `igl/cotmatrix.h` contains stored in an n-by-3 matrix of vertex positions `V` and an m-by-3 matrix of triangle indices `F`. -_Optionally_ the library may also be [pre-compiled](optional/) into a statically +_Optionally_ the library may also be [pre-compiled](http://libigl.github.io/static-library/) into a statically linked library, for faster compile times with your projects. This only effects compile time (run-time performance and behavior is identical). If in doubt, use the header-only default mode: (i.e. just include the headers you want to use). @@ -49,7 +49,7 @@ We provide a [blank project example](https://github.com/libigl/libigl-example-pr ## Coding Guidelines and Tips -libigl follows strict coding guidelines, please take a look [here](http://libigl.github.io/libigl/style-guidelines.html) before submitting your pull requests. We also have a set of [general coding tips](http://libigl.github.io/libigl/coding-guidelines.html) on how to code a geometry processing research project. +libigl follows strict coding guidelines, please take a look [here](http://libigl.github.io/libigl/style-guidelines) before submitting your pull requests. We also have a set of [general coding tips](http://libigl.github.io/libigl/coding-guidelines) on how to code a geometry processing research project. ## Installation @@ -100,7 +100,7 @@ Hello, mesh: Dependencies are on a per-include basis and the majority of the functions in libigl depends only on the [Eigen](http://eigen.tuxfamily.org) library. -For more information see our [tutorial](tutorial/tutorial.html). +For more information see our [tutorial](http://libigl.github.io/libigl/tutorial/tutorial.html). ### Optional Dependencies @@ -150,7 +150,7 @@ a major _todo_ for our development. ## Git Submodules Libigl uses git submodules for its _optional_ dependencies, in particular, those needed by the OpenGL viewer to run the examples in the -[tutorial](tutorial/tutorial.html). Git submodules allow use to treat clones of +[tutorial](http://libigl.github.io/libigl/tutorial/tutorial.html). Git submodules allow use to treat clones of other libraries as sub-directories within ours while separating our commits. Read the [documentation](http://git-scm.com/docs/git-submodule) for a detailed explanation, but essentially our libigl repo stores a hash for each of its @@ -175,7 +175,7 @@ repository](https://github.com/libigl/libigl-unit-tests) for unit testing. If you are interested in joining development, please fork the repository and submit a [pull request](https://help.github.com/articles/using-pull-requests/) -with your changes. libigl follows strict coding guidelines, please take a look at our [style guidelines](style-guidelines.html) before submitting your pull requests. +with your changes. libigl follows strict coding guidelines, please take a look at our [style guidelines](http://libigl.github.io/libigl/style-guidelines) before submitting your pull requests. ## License libigl is primarily [MPL2](http://www.mozilla.org/MPL/2.0/) licensed diff --git a/docs/python-bindings.md b/docs/python-bindings.md index b9527c095..f0dbc4935 100644 --- a/docs/python-bindings.md +++ b/docs/python-bindings.md @@ -125,7 +125,7 @@ When using the viewer from an interactive python shell (iPython), it is inconvenient to let the viewer take control of the main thread for rendering purposes. We provide a simple wrapper for the viewer that allows to launch a remote process and send meshes to it via a TCP/IP socket. For more -information on how to use it see the documentation in [tcpviewer.py](tcpviewer.py) +information on how to use it see the documentation in [tcpviewer.py]({{ repo_url }}/python/tcpviewer.py) ## Matlab diff --git a/docs/tutorial/chapter-1.md b/docs/tutorial/chapter-1.md index 0fefbdc57..191b220ac 100644 --- a/docs/tutorial/chapter-1.md +++ b/docs/tutorial/chapter-1.md @@ -31,7 +31,7 @@ libigl: 3. **Header-only.** It is straight forward to use our library since it is only one additional include directory in your project. (if you are worried about compilation speed, it is also possible to build the library as a [static - library](../optional/)) + library](../static-library/)) 4. **Function encapsulation.** Every function (including its full implementation) is contained in a pair of .h/.cpp files with the same name of diff --git a/docs/tutorial/tutorial.html b/docs/tutorial/tutorial.html new file mode 100644 index 000000000..b373723fd --- /dev/null +++ b/docs/tutorial/tutorial.html @@ -0,0 +1 @@ + diff --git a/mkdocs.yml b/mkdocs.yml index 6eb32d0e1..53d9628e8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -58,7 +58,7 @@ pages: - "Chapter 8: Outlook for continuing development": tutorial/chapter-8.md - Compilation: - Example Project: example-project.md - # - Static Library: static-library.md + - Static Library: static-library.md - External Dependencies: third-party.md - Python Bindings: python-bindings.md - Contributing: