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

Unifying .rst file's markup #6

Open
tommylenz opened this issue Dec 1, 2018 · 0 comments
Open

Unifying .rst file's markup #6

tommylenz opened this issue Dec 1, 2018 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@tommylenz
Copy link
Member

tommylenz commented Dec 1, 2018

When writing .rst files for our docs, it doesn't really matter what markup you use, e.g. a headline will be a headline no matter what kind of styling you use (refering to the sphinx docs):

##########
Headline 1
##########

Headline 2
==========

To make it easier to create and edit docs, we agreed on a markup-standart as follows:

Doc title
=========

Headline
--------

Subheadline
***********

Now, all docs need to be sighted and edited to fit the standart.

@tommylenz tommylenz added enhancement New feature or request help wanted Extra attention is needed labels Dec 1, 2018
@tommylenz tommylenz added this to the Tidy up our documentation milestone Dec 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant