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

Fix documentation #2549

Merged
merged 4 commits into from
Aug 29, 2023
Merged

Conversation

cvvergara
Copy link
Member

Fixes

  • migration documentation
    • reorganization of migration document. Keeping focus only on GSoC work (see image bellow)
    • Change examples to old/new documentation examples so that it is easier to see what is happening
  • Licenses: some names were removed some new names were missing
  • release notes & NEWS
    • Rewording in the availability section of the functions

Minor code changes

  • Standardizing error message when for the invalid driving side.

Other:

  • Change the way to write the history by using include sphinx command to include the text in availability of the functions
    • notes2news changes to get the information from the text in availability section of the functions
  • Removal of trailing spaces

image

@pgRouting/admins

Copy link
Member

@robe2 robe2 left a comment

Choose a reason for hiding this comment

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

Why are we using markdown syntax for links? I thought rst has to be like https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#links-to-external-web-pages

@robe2
Copy link
Member

robe2 commented Aug 29, 2023

ah nvermind I was looking at the NEWS which is md isntead of the rst files.

@robe2 robe2 self-requested a review August 29, 2023 14:52
@cvvergara cvvergara merged commit 691dd7f into pgRouting:develop Aug 29, 2023
@cvvergara cvvergara deleted the fix-doc-release-notes branch August 29, 2023 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants