Skip to content

Conversation

timotheecour
Copy link
Member

@timotheecour timotheecour commented Mar 27, 2021

follows #16999
refs #16999 (comment)

after PR, docs for highlight show as packages/docutils/highlite which is now correct, instead of highlite; indeed, packages/docutils/highlite works, import highlight doesn't work

future work

  • I've removed the only use of Tip::, docs for rst should mention this admonication somewhere

image

## .. Tip:: Import ``packages/docutils/rst`` to use this module
##    programmatically.
  • figure out what to do with nimsuggest/sexp.nim; it has an incorrect nimble package structure since we have:
nimsuggest/nimsuggest.nimble
nimsuggest/sexp.nim

as a result, its docs have this note:

## **Note:** Import ``nimsuggest/sexp`` to use this module

because the computed canonical import is sexp instead of nimsuggest/sexp

  • add nimforum to important_packages

@timotheecour timotheecour added the TODO: followup needed remove tag once fixed or tracked elsewhere label Mar 27, 2021
@timotheecour timotheecour requested a review from ringabout March 28, 2021 07:26
Copy link
Contributor

@dom96 dom96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a breaking change. It will break the forum at least.

Maybe we just need to move it to the stdlib? Including Nimble packages as part of Nim is tricky unfortunately. We should do our best to keep backwards compat in any case.

@timotheecour
Copy link
Member Author

timotheecour commented Mar 28, 2021

I think this is a breaking change. It will break the forum at least.

why is it a breaking change and how do i reproduce the breakage you're referring to?
nimforum has things like:

# src/utils.nim:
import rstgen

# src/nim.cfg:
path="$lib/packages/docutils"

but I don't why this PR would cause a breakage

on a related note, can you add nimforum to important_packages?

@Araq
Copy link
Member

Araq commented Mar 29, 2021

We'll add nimforum to important_packages later and see how it can compile with this patch applied.

@Araq Araq merged commit 8b26b3a into nim-lang:devel Mar 29, 2021
@timotheecour timotheecour deleted the pr_remove_docutils_nimble branch March 29, 2021 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

TODO: followup needed remove tag once fixed or tracked elsewhere

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants