Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] add readthedocs to the project #290

Open
4 tasks
florianlenz opened this issue Mar 14, 2018 · 0 comments
Open
4 tasks

[docs] add readthedocs to the project #290

florianlenz opened this issue Mar 14, 2018 · 0 comments
Assignees

Comments

@florianlenz
Copy link
Contributor

florianlenz commented Mar 14, 2018

Feature / Issue

Since we plan to grow as an organisation (we will hire more mobile dev's) we need a good way to document the project. The documentation will contain:

  • JSDoc directly taken form the source code (We want to avoid the need for copying over JS doc to the sphinx files)
  • Documentation that explain architecture / hight level stuff (not directly related to source code)

We will use http://readthedocs.io/ to host our documentation. It uses sphinx to generate documentation. There is a plugin called sphinx js which allow us to pull the javascript code directly from the js files instead of copying JSDoc over manually. There is need for writing a custom build logic since we probably need to strip the flow annotation's from the source code. After the build process succeed the files need to be pushed to read the docs via there api.

pangea ci

Acceptance criteria

  • Add read the docs and sphinx to the project
  • Create docker container for custom build logic
    • keep in mind that there is need for authentication in the build container if it's called
    • keep in mind that we need logging in case something escalates in the docker container. Papertrail is a fantastic service for logging.
@florianlenz florianlenz added this to the 0.4 milestone Mar 14, 2018
@florianlenz florianlenz removed this from the 0.4 milestone Jul 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants