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

Readthedocs import #784

Merged
merged 78 commits into from
Jun 6, 2019
Merged

Readthedocs import #784

merged 78 commits into from
Jun 6, 2019

Conversation

pgrandin
Copy link
Contributor

@pgrandin pgrandin commented Jun 4, 2019

This PR includes the config and documentation ported from the wiki (which suffers from too much spam and too little organization) to readthedocs

Any changes made to this branch will be visible within a few minutes at https://navit.readthedocs.io/en/latest/

pgrandin added 30 commits June 3, 2019 19:13
Copy link
Contributor

@aerostitch aerostitch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few change suggestions.
But aside from that it seems good to go.
We can make further improvements as we go.

pgrandin and others added 22 commits June 5, 2019 14:15
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
@pgrandin pgrandin merged commit 4b732b5 into trunk Jun 6, 2019
@pgrandin
Copy link
Contributor Author

pgrandin commented Jun 6, 2019

I merged the PR, but we should probably keep the branch as the latest version of the docs is built automatically from it. It'll be useful to test the next updates/import.

jandegr added a commit to jandegr/navit that referenced this pull request Jun 23, 2019
* Fix:core:Fix item_def.h when used whithout defined macros (like in IDE)

* Adding comments and const

* Change Variable to y because it holds the real string

* Fix:core:Fix Warning in IDE for Items not found

* Refactoring:cmake:simplify version management

* Refactoring:cmake:from 2.6 to 3.2

* Fixed typos

* Add:Gui/Internal: Adding missing escape modes and fixing generic html escape mode (navit-gps#785)

* Adding missing escape modes and fixing generic html escape mode

* Fixing comment

* Lining-up style

* Small typo fix

* Readthedocs import (navit-gps#784)

* First rftd.io import

* Testing Markdown doc

* Testing Markdown doc

* Testing RST

* Datetime is required

* Testing RST

* Adding a basic configuration page from the wiki

* Testing RST

* Testing syntax highlighting

* Testing syntax highlighting

* Testing syntax highlighting

* Importing https://wiki.navit-project.org/index.php/Maps

* Importing https://wiki.navit-project.org/index.php/Maps

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Fixing links

* Fixing links

* Fixing links

* Fixing links

* Fixing links

* Minor improvments

* Minor improvments

* Minor fixes

* Importing detailed configuration

* Improving the index page

* Removing copyright, it makes CodeFactor unhappy

* Added misspell checks

* Fixed wrong copy pasta

* Install curl, required to install misspell

* Fixed some typos

* Removed a bunch of trailing spaces

* Removed a bunch of trailing spaces

* Probably don't need "please" here.

* Reworking content

* Apply suggestions from code review

Remove unneeded white spaces before colon

* Apply suggestions from code review

Setting song for software or file names like the other occurences

* Update docs/binfile.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/advanced.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/advanced.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Removed wiki comment

* Update docs/configuration/display.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/display.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/general.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/general.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/general.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/layout.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/vehicle.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/vehicle.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/vehicle.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/vehicle.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/display.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Apply suggestions from code review

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* update:doc: add the submit patches section from the old wiki close to the code

* Fix typos

* Fix:bookmarks:Ensure that bookmarks are synced to disk

* fix:style:Fix tabs vs. spaces

* update:doc: Update the contributing.md to add the contributing section of the Programming guidelines (navit-gps#793)

* Disable maptool if protobuf-c not found

* fix:graphics:qt5: Remove unnecessary moc includes. (navit-gps#798)

* Remove unnecessary moc includes.

This commit removes moc file includes for some classes which do not
define new qt classes. This caused a long standing warning which seems
to be treated as error on some setups.

* Make (in)sanity check happy.

Here you got your bloody spaces. Uber picky, isn't it?

* Remove QAudio::interruptedState again

Sailfish version of QT doesn't feature this yet.

* Migrate the programming guidelines documentation to readthedocs (navit-gps#799)
@aerostitch aerostitch added the doc Related to documentation (source, Wiki, inline help etc...) label Oct 29, 2019
jkoan pushed a commit to jkoan/navit that referenced this pull request Jun 30, 2021
* First rftd.io import

* Testing Markdown doc

* Testing Markdown doc

* Testing RST

* Datetime is required

* Testing RST

* Adding a basic configuration page from the wiki

* Testing RST

* Testing syntax highlighting

* Testing syntax highlighting

* Testing syntax highlighting

* Importing https://wiki.navit-project.org/index.php/Maps

* Importing https://wiki.navit-project.org/index.php/Maps

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/Binfile

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Importing https://wiki.navit-project.org/index.php/OpenStreetMap

* Fixing links

* Fixing links

* Fixing links

* Fixing links

* Fixing links

* Minor improvments

* Minor improvments

* Minor fixes

* Importing detailed configuration

* Improving the index page

* Removing copyright, it makes CodeFactor unhappy

* Added misspell checks

* Fixed wrong copy pasta

* Install curl, required to install misspell

* Fixed some typos

* Removed a bunch of trailing spaces

* Removed a bunch of trailing spaces

* Probably don't need "please" here.

* Reworking content

* Apply suggestions from code review

Remove unneeded white spaces before colon

* Apply suggestions from code review

Setting song for software or file names like the other occurences

* Update docs/binfile.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/advanced.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/advanced.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Removed wiki comment

* Update docs/configuration/display.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/display.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/general.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/general.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/general.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/layout.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/vehicle.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/vehicle.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/vehicle.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/vehicle.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/index.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Update docs/configuration/display.rst

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>

* Apply suggestions from code review

Co-Authored-By: Joseph Herlant <aerostitch@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Related to documentation (source, Wiki, inline help etc...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants