Skip to content

Conversation

magdesign
Copy link

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.

Copy link
Owner

@rinigus rinigus left a 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.

@magdesign
Copy link
Author

magdesign commented Jan 21, 2025

  • yes, it can be build with github ci files, i have to look into this, but it should be more or less something like this

  • it builds on all platforms, i wrote and built it on a linux phone. just execute in docs-raw folder: make html and it builds to docs folder.

  • i dont know what a pickle file is... maybe the nojekyll file: without it github renders the page without styling.

  • the dublicated images:
    sphinx/rtd works like this: you create a source folder where you write the docs, from this you can generate html, pdf, doc whatever you need

@magdesign
Copy link
Author

added link to osmscout-server and slim version link under ubuntu touch.
ci script not done yet. ..

@magdesign
Copy link
Author

i added a workflow file on github, but i dont know how to run it.
i am mobile only and its a freaking pain to navigate github webpage on a small verical screen (and it eats all my nerves). please someone help on this or we just use the docs as is with building manually when making changes..🤷

@magdesign magdesign closed this Jan 26, 2025
@magdesign magdesign reopened this Jan 26, 2025
@rinigus
Copy link
Owner

rinigus commented Jan 27, 2025

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.

@magdesign
Copy link
Author

meaning you want someone to redo this as github pages, right?

why not cherrypick the docs folder to at least have some documentation for now (could create a new commit for that if needed)?

@rinigus
Copy link
Owner

rinigus commented Jan 29, 2025

meaning you want someone to redo this as github pages, right?

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 :)

@magdesign magdesign mentioned this pull request Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants