Skip to content

Commit

Permalink
Add documentation page to website. Add 2.0 release links/versioning t…
Browse files Browse the repository at this point in the history
…o website.
  • Loading branch information
connormanning committed Dec 19, 2018
1 parent 274f139 commit d13f6d0
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 22 deletions.
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@
# built documents.
#
# The short X.Y version.
version = u'1.3.0'
version = u'2.0'
# The full version, including alpha/beta/rc tags.
release = u'1.3.0'
release = u'2.0.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
13 changes: 13 additions & 0 deletions doc/source/documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. _documentation:

******************************************************************************
Documentation
******************************************************************************

For comprehensive information about all of the configuration options supported by Entwine, see the `configuration documentation`_ on GitHub.

To learn about Entwine's output format, a file format specification called Entwine Point Tile (EPT), see the `file format documentation`_ on GitHub.

.. _configuration documentation: https://github.com/connormanning/entwine/blob/master/doc/configuration.md
.. _file format documentation: https://github.com/connormanning/entwine/blob/master/doc/entwine-point-tile.md

10 changes: 6 additions & 4 deletions doc/source/download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,28 @@ Download
Current Release
------------------------------------------------------------------------------

- **2018-07-03** `entwine-1.3.0-src.tar.gz`_ (`release notes`_)
- **2018-12-18** `entwine-2.0.0-src.tar.gz`_ (`release notes`_)

.. _`entwine-1.3.0-src.tar.gz`: https://github.com/connormanning/entwine/archive/1.3.0.tar.gz
.. _`release notes`: https://github.com/connormanning/entwine/releases/tag/1.3.0
.. _`entwine-2.0.0-src.tar.gz`: https://github.com/connormanning/entwine/archive/2.0.0.tar.gz
.. _`release notes`: https://github.com/connormanning/entwine/releases/tag/2.0.0

Previous Releases
------------------------------------------------------------------------------

- **2018-07-03** `entwine-1.3.0-src.tar.gz`_ (`release notes`_)
- **2017-12-04** `entwine-1.2.0-src.tar.gz`_
- **2017-05-15** `entwine-1.1.0-src.tar.gz`_
- **2017-05-15** `entwine-1.0.0-src.tar.gz`_

.. _`entwine-1.3.0-src.tar.gz`: https://github.com/connormanning/entwine/archive/1.3.0.tar.gz
.. _`entwine-1.2.0-src.tar.gz`: https://github.com/connormanning/entwine/archive/1.2.0.tar.gz
.. _`entwine-1.1.0-src.tar.gz`: https://github.com/connormanning/entwine/archive/1.1.0.tar.gz
.. _`entwine-1.0.0-src.tar.gz`: https://github.com/connormanning/entwine/archive/1.0.0.tar.gz

Development Source
------------------------------------------------------------------------------

The main repository for Entwine is located on github at https://github.com/connormanning/entwine
The main repository for Entwine is located on github at https://github.com/connormanning/entwine.

You can obtain a copy of the active source code by issuing the following command::

Expand Down
7 changes: 4 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ Entwine
News
--------------------------------------------------------------------------------

**07-03-2018**
**2018-12-18**
................................................................................

Entwine 1.3 is now released. See :ref:`download` to obtain a copy of the source
Entwine 2.0 is now released. See :ref:`download` to obtain a copy of the source
code.

**12-01-2017**
**2017-12-01**
................................................................................

See `Connor Manning`_ present "`Trillions of points - spatial indexing, organization, and exploitation of massive point clouds`_" at `FOSS4G 2017`_ in Boston, MA USA in August 2017.
Expand All @@ -43,6 +43,7 @@ See `Connor Manning`_ present "`Trillions of points - spatial indexing, organiza
:hidden:

quickstart
documentation
download
community
presentations
Expand Down
14 changes: 1 addition & 13 deletions doc/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,10 @@ Now we can statically serve ``~/entwine`` with a simple HTTP server:

And view the data with `Potree`_ and `Plasio`_.

Going further
-------------

For detailed information about how to configure your builds, check out
the `configuration documentation`_. Here, you can find information about
reprojecting your data, using configuration files and templates,
enabling S3 capabilities, producing `Cesium 3D Tiles`_ output, and all
sorts of other settings.

To learn about the Entwine Point Tile file format produced by Entwine,
see the `file format documentation`_.
For further information about how to configure Entwine - like reprojecting data, using configuration files and templates, enabling S3 capabilities, and producing `Cesium 3D Tiles`_ output - see the :ref:`Documentation` section.

.. _Docker: http://docker.com
.. _Potree: http://potree.entwine.io/data/custom.html?r=http://localhost:8080/red-rocks/ept.json
.. _Plasio: http://dev.speck.ly/?s=0&r=ept://localhost:8080/red-rocks&c0s=local://color
.. _Cesium 3D Tiles: https://github.com/AnalyticalGraphicsInc/3d-tiles
.. _configuration documentation: https://github.com/connormanning/entwine/blob/master/doc/configuration.md
.. _file format documentation: https://github.com/connormanning/entwine/blob/master/doc/entwine-point-tile.md

0 comments on commit d13f6d0

Please sign in to comment.