# 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: ``` bash 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. ``` bash cd docs/ workon ramsey-uuid-docs make html ``` Then, to view the docs after building them: ``` bash open _build/html/index.html ``` [read the docs]: https://readthedocs.org
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
_static | Folder | 0755 |
|
|
customize | Folder | 0755 |
|
|
nonstandard | Folder | 0755 |
|
|
reference | Folder | 0755 |
|
|
rfc4122 | Folder | 0755 |
|
|
upgrading | Folder | 0755 |
|
|
.gitignore | File | 9 B | 0644 |
|
Makefile | File | 654 B | 0644 |
|
README.md | File | 771 B | 0644 |
|
conf.py | File | 3.32 KB | 0644 |
|
copyright.rst | File | 375 B | 0644 |
|
customize.rst | File | 2.3 KB | 0644 |
|
database.rst | File | 8.12 KB | 0644 |
|
faq.rst | File | 5.35 KB | 0644 |
|
index.rst | File | 1.22 KB | 0644 |
|
introduction.rst | File | 1012 B | 0644 |
|
nonstandard.rst | File | 1.42 KB | 0644 |
|
quickstart.rst | File | 3.94 KB | 0644 |
|
reference.rst | File | 837 B | 0644 |
|
requirements.txt | File | 72 B | 0644 |
|
rfc4122.rst | File | 2.59 KB | 0644 |
|
testing.rst | File | 6.11 KB | 0644 |
|
tidelift.rst | File | 3.14 KB | 0644 |
|
upgrading.rst | File | 167 B | 0644 |
|