This repository has been archived by the owner on Aug 26, 2022. It is now read-only.
Bug 950945: Fix and improve MDN Sphinx template #3954
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
Fix errors when running ./manage.py generate_sphinx_template to generate the Sphinx template for the MDN theme at: https://github.com/mdn/sphinx-theme In addition, fix some issues in the template: * Single-escape the title rather than double-escape * Copyright always covers current year * Add an empty <div class="page-buttons"> so wiki.js runs successfully * Add class="text-content" so documentation content is styled correctly * IE shims for old versions have the correct path
Omit the badges from the documentation, and preserve linebreaks in the quick links table.
Omit social tags, search nav, and Google Analytics initialization in the MDN Sphinx template.
jwhitlock
force-pushed
the
sphinx_template_950945
branch
from
5879b33
to
1d9b545
Compare
|
Force-push to remove the upgrade to unreleased |
Current coverage is 86.20% (diff: 100%)@@ master #3954 diff @@
==========================================
Files 146 145 -1
Lines 8912 8841 -71
Methods 0 0
Messages 0 0
Branches 1195 1188 -7
==========================================
- Hits 7671 7621 -50
+ Misses 1002 980 -22
- Partials 239 240 +1
|
| @@ -233,11 +236,11 @@ | |||
|
|
|||
| {{ providers_media_js() }} | |||
| {% javascript 'main' %} | |||
|
|
|||
| {% if not is_sphinx %} | |||
There was a problem hiding this comment.
We're tracking everything else on the docs, we might as well track the links.
There was a problem hiding this comment.
Pointed out on IRC that we include analytics.js but not ga.js so removing this makes sense.
|
Left some comments on mdn/sphinx-theme#10 |
Sync the version of Jinja2 in docs.txt with default.txt. docs.txt contains the requirements for building the documentation, which is normally not done in the development environment, but having the same versions will mean that it is safe to install them alongside other development requirements.
Documentation can be built in the VM, or experienced Python developers can create a new virtualenv to install the requirements and build the documentation, in a similar way to ReadTheDocs.
The <!DOCTYPE> tag is in the Jinja2 rendered output, but is not parsed as a token by html5lib. The html5lib docs imply that the "dom" treebuilder might parse this, but the default "etree" one does not. In any case, add it as the first element.
|
Comments the other repo were addressed 👍 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
./manage.py generate_sphinx_templatecommandThis PR is used to generate the changes in mdn/sphinx-theme#10, which is necessary to release
mdn-sphinx-themeversion 2016.0 and fix some issues with the current documentation.@stephaniehobson I'd appreciate a code review, especially of
base.htmlbut I don't expect you to generate the docs locally unless you are looking to level up in backend development.