50 lines
1.7 KiB
ReStructuredText
50 lines
1.7 KiB
ReStructuredText
Prototype Joyent Portal Docs
|
|
**************
|
|
|
|
This repo contains the source code for the `Prototype Joyent Portal docs`_.
|
|
|
|
Contributing
|
|
############
|
|
|
|
Fork the repo, make an edit, submit a PR. No patch is too small! <3
|
|
|
|
Building locally
|
|
################
|
|
|
|
1. Install `Sphinx <http://www.sphinx-doc.org/en/stable/>`_.
|
|
2. Install ``sphinx_rtd_theme`` with ``pip install sphinx_rtd_theme``
|
|
3. Run ``make html``
|
|
4. Open ``build/html/index.html`` in your browser.
|
|
|
|
Deployment
|
|
##########
|
|
|
|
``master`` is automatically deployed to `https://xxx <https://xxx/docs>`_.
|
|
|
|
License
|
|
#######
|
|
|
|
This project was forked from `https://github.com/shoreditch-ops/artillery-docs`_
|
|
|
|
::
|
|
|
|
The MIT License (MIT)
|
|
Copyright (c) 2015-2016 Shoreditch Ops Ltd
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included
|
|
in all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
|
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|