Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • documentation/doc
  • PhilH/doc
  • louis.csn/doc
  • fabien4vo/doc
  • rngadam/doc
  • anastasia/doc
6 results
Show changes
Commits on Source (396)
Showing
with 25 additions and 2 deletions
image: python:3.6
publish:
script:
script:
- pip install sphinx
- pip install sphinxcontrib-httpdomain
- pip install sphinx_rtd_theme
......@@ -9,5 +9,7 @@ publish:
- sphinx-build -d html "source" "build"
- echo "$SSH_DEPLOY_KEY" | tr -d '\r' > gitlab.key && chmod 600 gitlab.key
- scp -i gitlab.key -o StrictHostKeyChecking=no -r build/* documentation@astral.startinblox.com:~/doc/
only:
only:
- master
tags:
- deploy
# The main documentation
This is the repository of [the main documentation of Startin'blox](https://docs.startinblox.com/).
We use [Sphinx](https://www.sphinx-doc.org/en/master/) to manage the documentation and we use [Restructured Text](https://docutils.sourceforge.io/rst.html) to write it.
[Why we've chosen Restructured Text](https://www.ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/)
## How to update it
* Clone the repository
* Find the file you want to update and make your change
* Make a Merge Request and assign Alice Poggioli :)
## You get trouble ?
If you have any difficulties or feedbacks, we'll be pleased to improve the doc thanks to your contribution !
Contact the maintainer : alice@startinblox.com
Thanks!
\ No newline at end of file
File deleted
File deleted
File deleted
File deleted
source/_static/images/import_documentation/Components.png

115 KiB

source/_static/images/import_documentation/Framework-Overview.png

80.7 KiB

source/_static/images/import_documentation/Overview-of-SiB.png

90.6 KiB

source/_static/images/import_documentation/Overview-server.png

43.3 KiB

source/_static/images/import_documentation/Widgets-API-Developers.png

114 KiB

source/_static/images/import_documentation/core-architecture.png

1.05 MiB

File deleted
File deleted
source/_static/images/import_documentation/faq.gif

129 KiB

source/_static/images/import_documentation/federation.jpg

51.7 KiB

source/_static/images/import_documentation/federation.png

114 KiB