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

Migrate to docs written in Markdown #25

Open
dkastl opened this issue Nov 15, 2018 · 5 comments
Open

Migrate to docs written in Markdown #25

dkastl opened this issue Nov 15, 2018 · 5 comments

Comments

@dkastl
Copy link
Member

dkastl commented Nov 15, 2018

I think with version 3.0 of pgRouting we could use Markdown to generate documentation. And there are quite nice tools like this one:

@cvvergara
Copy link
Member

Currently:
The documentation examples are added like this:

:Example: Minimum Spanning Forest

.. literalinclude:: doc-pgr_kruskal.queries
   :start-after: -- q1
   :end-before: -- q2

A lot of documentation tables of inner queries are added like this:

Inner query
-------------------------------------------------------------------------------

.. rubric::edges_sql

.. include:: pgRouting-concepts.rst
   :start-after: basic_edges_sql_start
   :end-before: basic_edges_sql_end

Q1. does any of those tools allow something similar?


Q2. How would it affect gh-pages to keep the non 3.0 documentation?

@dkastl
Copy link
Member Author

dkastl commented Nov 26, 2018

Well, I don't actually know and didn't think about this case. So to answer Q1 I had to google a bit. And I don't really understand Q2, but this ticket is not so high priority and maybe we will never do it. I just like Markdown more than Retructured Text.

@dkastl
Copy link
Member Author

dkastl commented Nov 26, 2018

Just for myself as a reminder to read this later: https://docs.microsoft.com/en-us/contribute/how-to-write-use-markdown

@cvvergara
Copy link
Member

Well, pgRouting & workshop can keep the sphinx
the other repos can use other stuff

@dkastl
Copy link
Member Author

dkastl commented Jun 1, 2021

Maybe solved by #34 using Docusaurus?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants