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

[FIX] README template section levels #455

Closed
wants to merge 1 commit into from

Conversation

dreispt
Copy link
Member

@dreispt dreispt commented May 29, 2020

The README generation could return an error like this:

  docutils.utils.SystemMessage: account_avatax/README.rst:349: (SEVERE/4)
  Title level inconsistent:

  Authors
  ~~~~~~~

In fact the Authors section is inside a Credits first level title, ====,
and should be a second level title, ----,
instead of a third level, ~~~.

@dreispt dreispt force-pushed the fix-readme-section-levels branch from 46af185 to 65794a7 Compare May 29, 2020 13:47
@dreispt dreispt requested a review from sbidoul May 29, 2020 13:47
The README generation could return an error like this:

  docutils.utils.SystemMessage: account_avatax/README.rst:349: (SEVERE/4)
  Title level inconsistent:

  Authors
  ~~~~~~~

In fact the Authors section is inside a Credits first level title, ``====``,
and should be a second level title, ``----``,
instead of a third level, ``~~~``.
@dreispt dreispt force-pushed the fix-readme-section-levels branch from 65794a7 to 9dd5052 Compare May 29, 2020 13:57
@sbidoul
Copy link
Member

sbidoul commented May 29, 2020

Do you have an example where it failed?

@dreispt
Copy link
Member Author

dreispt commented May 29, 2020

Yes:
Pull OCA/account-fiscal-rule#116
Then run oca-gen-addon-readme --repo-name=account-fiscal-rule --branch=13.0 --addon-dir=account_avatax

@sbidoul
Copy link
Member

sbidoul commented May 30, 2020

@dreispt I think it should work if you change the section underlines to tilde (~) in your fragments.
It has been a restriction since the beginning that this is the only allowed title underline in fragments.
It is mentioned in the example here, although admitedly it is not easily discoverable.

@dreispt
Copy link
Member Author

dreispt commented Jun 1, 2020

Indeed those instructions could/should be in a better place. DESCRIPTION.rst sounds like the best place for it. Not finding them, I referred to the RST docs, and that led to this...

@dreispt
Copy link
Member Author

dreispt commented Jun 10, 2020

@sbidoul Investigating further, subsections are possible. I added documentation for this in the main DESCRIPTION fragment, in #460

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

Successfully merging this pull request may close these issues.

2 participants