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

Documentation non-existent module on docs #14593

Closed
juancarlospaco opened this issue Jun 7, 2020 · 1 comment · Fixed by #19083
Closed

Documentation non-existent module on docs #14593

juancarlospaco opened this issue Jun 7, 2020 · 1 comment · Fixed by #19083
Labels
Documentation Content Related to documentation content (not generation).

Comments

@juancarlospaco
Copy link
Collaborator

juancarlospaco commented Jun 7, 2020

Documentation mentions a non-existent module docstyle on devel docs,
basically is listed on the "Modules" section, but it is a documentation of best practices for documentation,
you can not really import the module, is on the wrong side of the documentation.

minibug

Theres not a problem with module docstyle itself, besides is not actually a module.
This is a Minor bug.
:)

@juancarlospaco
Copy link
Collaborator Author

juancarlospaco commented Jun 7, 2020

Is there kind of duplication/redundancy ?:

Maybe docstyle can be merged into docgen and fix this bug too ?. 🤔

@ghost ghost added the Documentation Content Related to documentation content (not generation). label Jul 25, 2020
kaushalmodi added a commit to kaushalmodi/Nim that referenced this issue Nov 1, 2021
Fixes nim-lang#14593.

The document needed a "title", which needed to be marked up as:

=====
TITLE
=====

Before this commit, the title was marked up as a h1-level heading.

As the h1 heading got promoted to be the page title, the h2-level
headings needed to be promoted to be h1-level headings.

Ref:
https://docutils.sourceforge.io/docs/user/rst/quickstart.html#document-title-subtitle
kaushalmodi added a commit to kaushalmodi/Nim that referenced this issue Nov 1, 2021
.. This doc is included in contributing.rst.

Fixes nim-lang#14593.
Araq pushed a commit that referenced this issue Nov 2, 2021
.. This doc is included in contributing.rst.

Fixes #14593.
PMunch pushed a commit to PMunch/Nim that referenced this issue Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Content Related to documentation content (not generation).
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant