Pre-release: Convert RST files to Markdown

[Elliria]

AutoKey is a Xorg application and will not function in a Wayland session. Do you use Xorg (X11) or Wayland?

Xorg

Has this issue already been reported?

• I have searched through the existing issues.

Is this a question rather than an issue?

• This is not a question.

What type of issue is this?

None

Choose one or more terms that describe this issue:

• autokey triggers
• autokey-gtk
• autokey-qt
• beta
• bug
• critical
• development
• documentation
• enhancement
• installation/configuration
• phrase expansion
• scripting
• technical debt
• user interface

Other terms that describe this issue if not provided above:

infrastructure

Which Linux distribution did you use?

No response

Which AutoKey GUI did you use?

None

Which AutoKey version did you use?

No response

How did you install AutoKey?

No response

Can you briefly describe the issue?

There are four RST files in the AutoKey repository and they're not used by actions, so all of them on all branches should be converted to Markdown files shortly before the next release:

• CHANGELOG.rst
• CONTRIBUTORS.rst
• README.rst
• new_features.rst

Can the issue be reproduced?

Always

What are the steps to reproduce the issue?

No response

What should have happened?

No response

What actually happened?

No response

Do you have screenshots?

No response

Can you provide the output of the AutoKey command?

No response

Anything else?

No response

[sebastiansam55]

something to note, the new site documentation works better (read natively uses RST) with RST files but I have no issue with converting the 4 listed here to markdown.

may have to test how it effects the documentation site but I believe it should be able to handle it or there's a plugin we can add that will handle it.

[Elliria]

Oh, do you mean that we could or should also do it to the new documentation site or that the four listed above could have an impact on the new documentation site if they're converted? By the way, welcome back, @sebastiansam55.

[sebastiansam55]

It looks like the sphinx plugin for markdown is present in the documentation configuration so it should just work.

may be minor layout changes but nothing to be concerned with imo

[Elliria]

It's up to you. I poked around in the files and the biggest .rst file is the intro.rst file. All the rest are tiny. If we do it, it should become a separate issue in the new documentation's repository, though. The current issue is about the AutoKey repository.