Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
customize		customize
nonstandard		nonstandard
reference		reference
rfc4122		rfc4122
upgrading		upgrading
.gitignore		.gitignore
Makefile		Makefile
README.md		README.md
conf.py		conf.py
copyright.rst		copyright.rst
customize.rst		customize.rst
database.rst		database.rst
faq.rst		faq.rst
index.rst		index.rst
introduction.rst		introduction.rst
nonstandard.rst		nonstandard.rst
quickstart.rst		quickstart.rst
reference.rst		reference.rst
requirements.txt		requirements.txt
rfc4122.rst		rfc4122.rst
testing.rst		testing.rst
tidelift.rst		tidelift.rst
upgrading.rst		upgrading.rst

README.md

ramsey/uuid Documentation

Changes to the documentation are automatically built by Read the Docs and viewable from https://uuid.ramsey.dev.

Getting Started

It's probably best to do this in a virtualenv environment, so set one up first:

pip install virtualenvwrapper
mkvirtualenv ramsey-uuid-docs
cd docs/
workon ramsey-uuid-docs
pip install -r requirements.txt

Building the Docs

To build the docs, change to the docs/ directory, and make sure you're working on the virtualenv environment created in the last step.

cd docs/
workon ramsey-uuid-docs
make html

Then, to view the docs after building them:

open _build/html/index.html