Merge pull request #3 from UDST/url-fixes

Landing page updates
UDST · Feb 4, 2019 · 0374cdc · 0374cdc
2 parents 630788e + 92a1c10
commit 0374cdc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -2,15 +2,15 @@
 
 # udst-docs
 
-This repo generates the ReadTheDocs landing page for UDST documentation.
+This repo generates the landing page for UDST documentation, hosted at https://docs.udst.org and https://udst-docs.readthedocs.io.
 
 ### How it works
 
-ReadTheDocs.org automatically builds the page defined in `docs/source/index.rst` and hosts it at https://udst-docs.readthedocs.io (soon http://docs.udst.org). Builds are triggered each time the master branch changes.
+ReadTheDocs.org builds and hosts the Sphinx page defined in `docs/source/index.rst`. Builds are triggered when the master branch of this Github repo changes.
 
-### Updating the page
+### Updating the landing page
 
-Documentation is built using Sphinx. Here's a [good tutorial](https://pythonhosted.org/an_example_pypi_project/sphinx.html). Edit `index.rst` and `conf.py` to change what appears on the page.
+The page is built using the Sphinx documentation generator. Here's a [good tutorial](https://pythonhosted.org/an_example_pypi_project/sphinx.html). Edit `index.rst` and `conf.py` to change what appears on the page.
 
 ### Previewing changes locally
 
@@ -24,5 +24,6 @@ The build files won't be committed to the repo; ReadTheDocs will create a separa
 
 Hosting settings are at https://readthedocs.org/projects/udst-docs/. If you don't have access, create a ReadTheDocs account and ask one of the existing maintainers to add you.
 
-Other UDST projects whose documentation shares the same domain are marked in ReadTheDocs as "subprojects" of this one.
+The DNS settings for the docs.udst.org subdomain contain a CNAME record redirecting traffic to readthedocs.io. ReadTheDocs handles the SSL certificate for https. 
 
+Other UDST projects whose documentation uses this domain (e.g. [ChoiceModels](https://docs.udst.org/projects/choicemodels/en/latest)) have to be marked in ReadTheDocs as "subprojects" of the landing page.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -16,12 +16,12 @@ Libraries
 .. toctree::
    :maxdepth: 2
 
-   ChoiceModels <https://udst-docs.readthedocs.io/projects/choicemodels>
+   ChoiceModels <https://docs.udst.org/projects/choicemodels/en/latest>
    Orca <https://udst.github.io/orca>
    Pandana <http://udst.github.io/pandana>
    Spandex <https://github.com/udst/spandex>
    Synthpop <https://github.com/udst/synthpop>
    UrbanAccess <https://udst.github.io/urbanaccess>
    UrbanSim <https://udst.github.io/urbansim>
-   UrbanSim Templates <https://udst-docs.readthedocs.io/projects/urbansim_templates>
+   UrbanSim Templates <https://udst.github.io/urbansim_templates>