Michigan Technological University CS 3141 Team Software Project for Creating Fictional City Maps.

I'll let you know when there is code to use...

Use the link above to see the formal documentation on the inner works of Atlas.

How to build the documentation:

Add new classes to the documentation by running the following command in the terminal.

/atlas/docs> sphinx-apidoc -o ./source ../src/Frontend
/atlas/docs> sphinx-apidoc -o ./source ../src/Backend

Then add the name of the new .rst file to index.rst in alphabetic order. Build the documentation

/atlas/documentation> make clean
/atlas/documentation> make html

This will put the new webpages in /documentation/build/html/.

Next, copy all the files from /documentation/build/html to /docs/, which is where Github pages will look for them. Now, apparently Github pages does not like directories which start with an underscore, so be sure to refactor /_static/ and /_source/ to remove the underscore. Finally, commit to the repo, and the documentation will be updated.

We will be using NetworkX to represent a graph and numpydoc to generate documentation. We also use SciPy to generate convex hulls and Voronoi diagrams

pip install networkx
pip install numpydoc