-
Notifications
You must be signed in to change notification settings - Fork 51
Add doc pages #692
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
base: master
Are you sure you want to change the base?
Add doc pages #692
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few general questions regarding it:
-
would it build using CI and upload to Github pages?
-
would it build on Linux? seems like there is windows bat file included
-
are we expected to have rst and rst.txt files? how are they related?
-
are we expected to have pickle file as a part of commit? isn't it something that should be generated during a build? or that's the way env is constructed in this case?
-
images seem to be duplicated, why? under docs-raw/source/_static and docs/_images. there is also docs/_static with the same ones
-
OSM Scout Server has its own doc site - please refer there and keep in Pure Maps only bits that are explaining how to connect to it.
|
Co-authored-by: Jonatan Hatakeyama Zeidler <[email protected]>
added link to osmscout-server and slim version link under ubuntu touch. |
action to build docs
added nojekyll
create docs
figuring out docs build
i added a workflow file on github, but i dont know how to run it. |
Actually, we should just use Github pages: https://docs.github.com/en/pages/quickstart . No special CI is needed. Please see docs subfolder in Pure Maps - that's already runs https://rinigus.github.io/pure-maps/ Please make sure that there are no duplicated files, only sources that will be used by jekyll or some alternative to generate pages using Github server and then serve it. |
meaning you want someone to redo this as github pages, right? why not cherrypick the |
I want it to be easily maintainable. Its hard to find time to work on the apps, hence not much is happening here. Web site would be of great help, but it has to be simple to change. GitHub pages is surely a simple option as we will not have many copies of the same text :) |
Added docs with sphinx as mentiined in #400.
Before merging, you can preview here.
Will add more from time to time, thought its better to 'release early' and 'release often'.
Hope to get some constructive feedback as well as maybe a screenshot if it looks weird on a big screen. All made on a linux mobile phone and it displays nice here.