Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • M MathJax
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 304
    • Issues 304
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 15
    • Merge requests 15
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • MathJax
  • MathJax
  • Wiki
  • Documentation update process

Documentation update process · Changes

Page history
small update authored Oct 03, 2012 by pkra's avatar pkra
Hide whitespace changes
Inline Side-by-side
Documentation-update-process.md
View page @ 7029a183
......@@ -22,6 +22,7 @@ When you save your changes version, GitHub automatically creates a fork (if it d
1. Build the HTML for the new branch `sphinx-build . vN.M-latest/` (this creates a new folder `vN.M-latest`).
1. Check out the release before the new release say `vA.B-latest`.
2. Change the theme of `vA.B-latest` to add the version warning: modify `_theme/sphinx-bootstrap/layout.html` (see older branches for the code snippet).
1. Update the `sourcelink` in `_templates` to point to the branch (not `master`).
1. Build the HTML for the branch `sphinx-build . vA.B-latest/`.
1. Checkout the `gh-pages` branch: `git checkout gh-pages` (this will leave the new folders in place).
1. Move the new folders to `en/.`
......@@ -42,7 +43,11 @@ If Read The Docs updates their jquery, we can host the documentation there direc
### Appendix: Modifying the theme
If you have to work on the sphinx-theme (currently [sphinx-bootstrap]()), you should update all branches. It's best to modify the `v1.0` branch and merge the changes into the others.
If you have to work on the sphinx-theme (currently [sphinx-bootstrap]()), you should update all branches. Due to the hacks in the theme, you'll have to do this manually for each branch.
Hacks include:
* the sphinx-bootstrap `layout.html` contains version-warning button -- which is only appropriate for older versions
* the `sourcelink` in templates is different for each version.
**Warning** There's one difference between the theme in the latest branch and all others: the theme for older branches contains a version warning! Be sure to check that you didn't add the version warning to the branch of the current version and the master branch.
......
Clone repository

MathJax Wiki

  • Contributing
  • Development
    • Development Process
      • Release Process Checklist
      • Hotfix Release Process
      • Documentation Update Process
      • Source Control Policies
    • Design Documents
      • MathJax Roadmap
      • CDN Hosting
        • Managing Rackspace Cloud Files & CDN
        • Directory Structure
        • .htaccess settings
        • Managing Amazon Cloudfront
      • Performance Discussion
      • Profiling and Diagnostics Tools
      • Configuration Options
      • Documentation generation guide
      • Testing
        • Platforms supported
        • Amazon EC2
        • DSI test machine
  • MathJax web presence