From 87f418b7a8f636908907ffef8fe81b7bca5c05a9 Mon Sep 17 00:00:00 2001
From: lunamorrow <luna.morrow2@gmail.com>
Date: Mon, 17 Feb 2025 15:57:44 +1000
Subject: [PATCH] Add warning and link to documentation in docs/README.md and
 update build instructions to make installing correct python version easier

---
 README.md                       | 16 ++++++----------
 docs/README.md                  | 26 ++------------------------
 docs/source/getting_started.rst | 13 +------------
 3 files changed, 9 insertions(+), 46 deletions(-)

diff --git a/README.md b/README.md
index 17b5196..cde602d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,8 @@
+# PolyConstruct Documentation
+
+[PolyConstruct ReadTheDocs](https://polyconstruct.readthedocs.io/en/latest/).
+
+
 # Setup for PolyConstruct
 
 From your home directory, install PolyConstruct from Git:
@@ -16,21 +21,12 @@ cd polyconstruct
 To setup polyconstruct, run: 
 
 ```
-conda create --name polyconstruct-env
+conda create --name polyconstruct-env python=3.10
 conda activate polyconstruct-env
 
 pip install -r requirements.txt
 ```
 
-If you recieve an error in the last step, it may be from the Python version on
-your computer setup, as PolyTop has a strict requirement for version 3.10. Run
-the below commands then repeat `pip install -r requirements.txt` :
-
-```
-conda uninstall python
-conda install "python=3.10"
-```
-
 Then, build the PolyTop, PolyConf and PolyBuild packages:
 
 ```
diff --git a/docs/README.md b/docs/README.md
index 71b7b24..025b736 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,24 +1,2 @@
-# Compiling mda-openbabel-converter's Documentation
-
-The docs for this project are built with [Sphinx](http://www.sphinx-doc.org/en/master/).
-To compile the docs, first ensure that Sphinx and the ReadTheDocs theme are installed.
-
-
-```bash
-conda install sphinx sphinx_rtd_theme 
-```
-
-
-Once installed, you can use the `Makefile` in this directory to compile static HTML pages by
-```bash
-make html
-```
-
-The compiled docs will be in the `_build` directory and can be viewed by opening `index.html` (which may itself 
-be inside a directory called `html/` depending on what version of Sphinx is installed).
-
-
-A configuration file for [Read The Docs](https://readthedocs.org/) (readthedocs.yaml) is included in the top level of the repository. To use Read the Docs to host your documentation, go to https://readthedocs.org/ and connect this repository. You may need to change your default branch to `main` under Advanced Settings for the project.
-
-If you would like to use Read The Docs with `autodoc` (included automatically) and your package has dependencies, you will need to include those dependencies in your documentation yaml file (`docs/requirements.yaml`).
-
+Oops, you have found a non-human readable area! To view the PolyConstruct
+documentation, please go to [PolyConstruct ReadTheDocs](https://polyconstruct.readthedocs.io/en/latest/).
\ No newline at end of file
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
index 9c54b77..53bdf2d 100644
--- a/docs/source/getting_started.rst
+++ b/docs/source/getting_started.rst
@@ -23,22 +23,11 @@ To setup an environment for polyconstruct, run:
 
 .. code-block:: python
 
-    conda create --name polyconstruct-env
+    conda create --name polyconstruct-env python=3.10
     conda activate polyconstruct-env
 
     pip install -r requirements.txt
 
-
-If you recieve an error in the last step above, it may be from the Python
-version on your computer setup, as PolyTop has a strict requirement for version
-3.10. Run the below commands then repeat `pip install -r requirements.txt` :
-
-.. code-block:: python
-
-    conda uninstall python
-    conda install "python=3.10"
-
-
 Then, build the PolyTop, PolyConf and PolyBuild packages:
 
 .. code-block:: python