-
Notifications
You must be signed in to change notification settings - Fork 57
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
Open
magdesign
wants to merge
21
commits into
rinigus:master
Choose a base branch
from
magdesign:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add doc pages #692
Changes from 9 commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
d7f5870
setup redthedocs
0940d3a
add basic doc
29ae092
docs rendered
16f7412
docs as gh-pages
c7d1e31
fix styling for gh-pages ?
6bf0eee
nojekyll to fix styling
379285b
definde image width
e66ce6d
add docs content
eeaee68
docs ready
875a270
link to osmscout-server docs
3cd6b49
Update docs-raw/source/installation.rst
f9dad72
slim version on ubuntu touch
f1590bd
update preview
690ccb6
typo in troubleshooting
d51f0f6
Create docs.yml
c9b3bfa
Update docs.yml
cdd51f5
try to get it built
75270ef
Update docs.yml
ba48b22
Update docs.yml
7658234
manually add docs
41f8de8
nojekyll
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Minimal makefile for Sphinx documentation | ||
| # | ||
|
|
||
| # You can set these variables from the command line, and also | ||
| # from the environment for the first two. | ||
| SPHINXOPTS ?= | ||
| SPHINXBUILD ?= sphinx-build | ||
| SOURCEDIR = source | ||
| BUILDDIR = ../docs | ||
|
|
||
| # Put it first so that "make" without argument is like "make help". | ||
| help: | ||
| @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
|
||
| .PHONY: help Makefile | ||
|
|
||
| # Catch-all target: route all unknown targets to Sphinx using the new | ||
| # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
| %: Makefile | ||
| @$(SPHINXBUILD) -b $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| @ECHO OFF | ||
|
|
||
| pushd %~dp0 | ||
|
|
||
| REM Command file for Sphinx documentation | ||
|
|
||
| if "%SPHINXBUILD%" == "" ( | ||
| set SPHINXBUILD=sphinx-build | ||
| ) | ||
| set SOURCEDIR=source | ||
| set BUILDDIR=build | ||
|
|
||
| %SPHINXBUILD% >NUL 2>NUL | ||
| if errorlevel 9009 ( | ||
| echo. | ||
| echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | ||
| echo.installed, then set the SPHINXBUILD environment variable to point | ||
| echo.to the full path of the 'sphinx-build' executable. Alternatively you | ||
| echo.may add the Sphinx directory to PATH. | ||
| echo. | ||
| echo.If you don't have Sphinx installed, grab it from | ||
| echo.https://www.sphinx-doc.org/ | ||
| exit /b 1 | ||
| ) | ||
|
|
||
| if "%1" == "" goto help | ||
|
|
||
| %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
| goto end | ||
|
|
||
| :help | ||
| %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
|
|
||
| :end | ||
| popd |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Configuration file for the Sphinx documentation builder. | ||
| # | ||
| # For the full list of built-in configuration values, see the documentation: | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
|
|
||
| # -- Project information ----------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||
|
|
||
| project = 'pure-maps' | ||
| copyright = '2025, pure-maps' | ||
| author = 'magdesign' | ||
|
|
||
| # -- General configuration --------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration | ||
|
|
||
| extensions = [ | ||
| # 'sphinx_toolbox.shields' | ||
| ] | ||
|
|
||
|
|
||
|
|
||
| templates_path = ['_templates'] | ||
| exclude_patterns = [] | ||
|
|
||
|
|
||
|
|
||
| # -- Options for HTML output ------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output | ||
| import sphinx_rtd_theme | ||
|
|
||
| html_theme = 'sphinx_rtd_theme' | ||
| html_logo = 'logo.svg' | ||
| html_theme_options = { | ||
| 'logo_only': False, | ||
| 'display_version': False, | ||
| } | ||
| html_static_path = ['_static'] |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| .. _faq: | ||
|
|
||
| FAQ | ||
| === | ||
| Frequently asked questions: | ||
|
|
||
| Can i use pure-maps offline? | ||
| Yes, when running :ref:`osmscout-server` | ||
| Pure Maps navigates completely offline. | ||
| See :ref:`Offline-Navigation` | ||
|
|
||
| Can I import .gpx tracks? | ||
| Yes, but its limited to the navigation module. | ||
| See :ref:`GPX-Import` | ||
|
|
||
| Does Pure Maps display height profiles? | ||
| No. | ||
|
|
||
| Why can't I route long trips for walking or cycling in offline mode? | ||
| Increase limits in :ref:`osmscout-server`-gui in | ||
| ``Settings > Backend settings > Valhalla > Limits``. |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| .. _index: | ||
|
|
||
| Pure Maps | ||
| ========= | ||
|
|
||
| **Pure Maps** is an application for Linux to display vector and raster | ||
| maps, places, routes and provide navigation instructions with a | ||
| flexible selection of data and service providers. Its designed for mobile devices. | ||
|
|
||
| .. image:: _static/01_pure-maps_satelite.png | ||
| :alt: pure-maps screenshot | ||
| :width: 400 | ||
|
|
||
| .. image:: https://img.shields.io/github/v/release/rinigus/pure-maps | ||
| :alt: Latest Release | ||
| :target: https://github.com/rinigus/pure-maps/releases | ||
|
|
||
| .. image:: https://img.shields.io/badge/Ubuntu%20Touch-OpenStore-292929 | ||
| :alt: Ubuntu Touch | ||
| :target: https://open-store.io/app/pure-maps.jonnius | ||
|
|
||
| .. image:: https://img.shields.io/badge/Flatpak-Flathub-4A86CF | ||
| :alt: Flatpak | ||
| :target: https://flathub.org/apps/details/io.github.rinigus.PureMaps | ||
|
|
||
| .. image:: https://img.shields.io/badge/O.B.S-Fedora-3C6EB4 | ||
| :alt: Fedora | ||
| :target: https://build.opensuse.org/package/show/home:rinigus:maps/pure-maps | ||
|
|
||
| .. image:: https://img.shields.io/badge/matrix.org-%23pure--maps-blue | ||
| :alt: Matrix | ||
| :target: https://matrix.to/#/#pure-maps:matrix.org | ||
|
|
||
| .. image:: https://img.shields.io/badge/forum-GitHub-FB9200 | ||
| :alt: Discussions | ||
| :target: https://github.com/rinigus/pure-maps/discussions | ||
|
|
||
|
|
||
|
|
||
| .. Note:: | ||
| Add your content using ``reStructuredText`` syntax to ``docs-raw`` folder. See this `issue`_ and | ||
| `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ | ||
| documentation for details. | ||
|
|
||
| .. _issue: https://github.com/rinigus/pure-maps/issues/400 | ||
|
|
||
|
|
||
| User feedback | ||
| -------------- | ||
|
|
||
| Use `Github Issues`_ to address specific problems and development | ||
| requests. | ||
|
|
||
| General discussion is expected either through corresponding | ||
| topics in `Github Discussions`_, `Github Issues`_ , `Matrix channel`_, | ||
| or `TMO`_ thread. | ||
|
|
||
| .. _Github Issues: https://github.com/rinigus/pure-maps/issues | ||
|
|
||
| .. _Github Discussions: https://github.com/rinigus/pure-maps/discussions | ||
|
|
||
| .. _Matrix channel: https://matrix.to/#/#pure-maps:matrix.org | ||
|
|
||
| .. _TMO: https://talk.maemo.org/showthread.php?t=100442 | ||
|
|
||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Content | ||
|
|
||
| faq | ||
| installation | ||
| usage | ||
| osmscout-server | ||
| troubleshooting |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| .. _installation: | ||
|
|
||
| Installation | ||
| ============== | ||
|
|
||
| **Linux** | ||
|
|
||
| On most popular distributions Pure Maps can | ||
| simply be installed via package manager. | ||
|
|
||
| .. image:: https://repology.org/badge/vertical-allrepos/pure-maps.svg | ||
| :alt: Packaging status | ||
| :target: https://repology.org/project/pure-maps/versions | ||
|
|
||
|
|
||
| For example on Alpine/postmarketOS: | ||
|
|
||
| .. code-block:: shell | ||
|
|
||
| sudo apk add pure-maps osmscout-server | ||
|
|
||
|
|
||
| **Flatpak** | ||
|
|
||
| There is a Flatpak build on `flathub`_. | ||
|
|
||
| .. code-block:: shell | ||
|
|
||
| sudo flatpak install flathub io.github.rinigus.PureMaps | ||
| sudo flatpak install flathub io.github.rinigus.OSMScoutServer | ||
|
|
||
| .. _flathub: https://flathub.org/apps/io.github.rinigus.PureMaps | ||
|
|
||
| **UBports** | ||
|
|
||
| Install via `open-store`_ | ||
|
|
||
| .. _open-store: https://open-store.io/app/pure-maps.jonnius | ||
|
magdesign marked this conversation as resolved.
Outdated
|
||
|
|
||
| **Sailfish** | ||
|
|
||
| Install via `chum`_ | ||
|
|
||
| .. _chum: https://build.sailfishos.org/package/show/sailfishos:chum/pure-maps' | ||
|
|
||
|
|
||
| .. _API_key: | ||
|
|
||
| API Keys | ||
| --------- | ||
| To get access to online maps, its | ||
| recommended to go to ``Preferences > API keys`` | ||
| and add API keys. You get them with | ||
| registering on each linked map provider. | ||
|
|
||
| .. image:: _static/03_preferences_api-key.png | ||
| :alt: api keys page | ||
| :width: 400 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.