remove website generation code #201
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The pieces being removed are:
- `koch`'s "web" doc generation, which has the following differences to
"regular" docs:
- Docs meant for publishing have Google Analytics (GA) enabled.
- `nimblepkglist` was bundled to enable the display of the nimble
catalogue in "Standard library" page. This feature is no longer
used, even on Nim's published docs, since it is fairly slow and was
not updated for the new docs layout. Alternative providers like
https://nimble.directory have completely superseded it.
- Google Analytics script injection in docgen: The script is injected
whenever `--doc.googleAnalytics:<GA code>` is passed to `nim doc`.
- `nimweb`: A tool that appears to be used to generate the first
generation of the Nim's website. Needless to say, it's pretty
abandoned given the Jekyll-based version:
https://github.com/nim-lang/website.
We have no use for any of these, so shake them off to reduce code size.
An added benefit is that koch docs is slightly faster as we are no
longer generating the same documentation twice.
|
Build succeeded: |
|
I can confirm author is responsive. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull purges the code related to Nim's website generation from the codebase.
Details
The pieces being removed are:
koch's "web" doc generation, which has the following differences to "regular" docs:nimblepkglistwas bundled to enable the display of the nimble catalogue in "Standard library" page. This feature is no longer used, even on Nim's published docs, since it is fairly slow and was not updated for the new docs layout. Alternative providers like https://nimble.directory have completely superseded it.--doc.googleAnalytics:<GA code>is passed tonim doc.nimweb: A tool that appears to be used to generate the first generation of the Nim's website. Needless to say, it's pretty abandoned given the Jekyll-based version: https://github.com/nim-lang/website.Closes #129 as this pull removes
nimblepkglistas well, and the author of that PR is no longer responsive.