pgRouting / admin

Cross-project tasks and organizational items
1 stars 0 forks source link

Migrate to docs written in Markdown #25

Open dkastl opened 5 years ago

dkastl commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

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

cvvergara commented 5 years ago

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

dkastl commented 3 years ago

Maybe solved by #34 using Docusaurus?