-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d221497
commit d480786
Showing
48 changed files
with
36 additions
and
15,898 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
{ | ||
"restructuredtext.confPath": "${workspaceFolder}/docs" | ||
"restructuredtext.confPath": "${workspaceFolder}\\docs" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,37 @@ | ||
# kintyre-runway-docs | ||
# Cloud Native Runway | ||
|
||
Cloud-Native Runway Docs hosted on https://readthedocs.io | ||
> Source code for Kintyre's Cloud Native Runway documentation hosted on [readthedocs](https://kintyre-runway-docs.readthedocs.io/) | ||
WIP | ||
## Table of Contents | ||
|
||
* [General info](#general-info) | ||
* [Requirements](#requirements) | ||
* [Deployment](#deployment) | ||
* [Context](#context) | ||
* [Contact](#contact) | ||
|
||
## General info | ||
|
||
These documents are written in [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html). | ||
|
||
## Requirements | ||
|
||
Take a look at the [readthedocs getting started guide](https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html). | ||
|
||
## Deployment | ||
|
||
To make quick changes, just commit your edits and push to `master`. Once the automated build process completes, you'll be able to see your changes in the Runway's [readthedocs site](https://kintyre-runway-docs.readthedocs.io/). | ||
|
||
If you've installed the [required Python libraries](https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html), you can `make html` and generate the docs locally. | ||
|
||
## Context | ||
|
||
To make your reStructuredText composition a little easier: | ||
|
||
* Edit on the web: [Rsted](http://rst.ninjs.org/) | ||
|
||
* Edit locally: Grab the reStructuredText [VS Code extension](https://docs.restructuredtext.net/) | ||
|
||
## Contact | ||
|
||
hello@kintyre.co |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Empty file.
Oops, something went wrong.