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.

Sign up for GitHub

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

Jump to bottom

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 •
edited
Loading

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 •
edited
Loading

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
@kaushalmodi
docstyle.rst: Fix the page title ReST markup
278705c 
Fixes nim-lang#14593.

Ref:
https://docutils.sourceforge.io/docs/user/rst/quickstart.html#document-title-subtitle
@kaushalmodi kaushalmodi mentioned this issue Nov 1, 2021
Merged
kaushalmodi added a commit to kaushalmodi/Nim that referenced this issue Nov 1, 2021
@kaushalmodi
docstyle.rst: Fix the page title ReST markup
a50d92c 
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
@kaushalmodi
docstyle.rst: Do not export it to HTML as a standalone doc
4ee2ba7 
.. This doc is included in contributing.rst.

Fixes nim-lang#14593.
Araq pushed a commit that referenced this issue Nov 2, 2021
@kaushalmodi
docstyle.rst: Do not export it to HTML as a standalone doc (#19083)
efaaa38 
.. This doc is included in contributing.rst.

Fixes #14593.
PMunch pushed a commit to PMunch/Nim that referenced this issue Mar 28, 2022
@kaushalmodi @PMunch
docstyle.rst: Do not export it to HTML as a standalone doc (nim-lang#…
64fa5d3 
…19083)

.. This doc is included in contributing.rst.

Fixes nim-lang#14593.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Content Related to documentation content (not generation).
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docstyle.rst: Do not export it to HTML as a standalone doc kaushalmodi/Nim
1 participant
@juancarlospaco