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

sphinx Add support for markdown files #9139

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ptitjano
Copy link
Contributor

Goal:

This adds support to use markdown files to generate the
documentation. The existing rst files still work and this allows to
mix them with markdown files. Both formats coexist without any
friction.

This way, a contributor can use its favorite format. Besides, markdown
syntax is considered easier to write than the rst one. This might
attract new contributors to the project.

This also introduces a new dependency for markdown parsing:
myst-parser.

See: https://www.sphinx-doc.org/en/master/usage/markdown.html

Related: https://github.com/qgis/QGIS-Website/pull/1255

This adds support to use markdown files to generate the
documentation. The existing `rst` files still work and this allows to
mix them with markdown files. Both formats coexist without any
friction.

This way, a contributor can use its favorite format. Besides, markdown
syntax is considered easier to write than the rst one. This might
attract new contributors to the project.

This also introduces a new dependency for markdown parsing:
`myst-parser`.

See: https://www.sphinx-doc.org/en/master/usage/markdown.html
@ptitjano
Copy link
Contributor Author

I already have some existing training material for QGIS 3D. However, it is written with the markdown syntax. With this change, it will be possible to directly add it to the existing QGIS training material.

@Guts
Copy link
Contributor

Guts commented Jun 17, 2024

Great idea 👏!

@DelazJ
Copy link
Collaborator

DelazJ commented Jul 5, 2024

Hi @ptitjano

This way, a contributor can use its favorite format. Besides, markdown syntax is considered easier to write than the rst one. This might attract new contributors to the project.

I read this for years, and am not really convinced, but let's take the opportunity and give it a shot.

I already have some existing training material for QGIS 3D. However, it is written with the markdown syntax. With this change, it will be possible to directly add it to the existing QGIS training material.

Mind opening a PR with these changes or at least a .md file for example? What matters IMHO is to experiment the build process and the outputs, and find what is compatible and what can't be or requires some configuration.
I want to be sure of how things correctly play before requiring that the docker image for build on the server gets updated. Thanks for your understanding.

@DelazJ DelazJ added the Backend label Jul 16, 2024
@DelazJ
Copy link
Collaborator

DelazJ commented Jul 29, 2024

Another question that comes to mind, given the QGIS website context, is if it is possible and what specific changes are needed to have the new .md files translatable...

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

Successfully merging this pull request may close these issues.

3 participants