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 temporary notes for the move to readthedocs

Documentation temporary notes for the move to readthedocs · Changes

Page history
now with gh-pages build script... authored Sep 24, 2012 by pkra's avatar pkra
Hide whitespace changes
Inline Side-by-side
Documentation----temporary-notes-for-the-move-to-readthedocs.md
View page @ 3837e4fc
...@@ -27,6 +27,42 @@ Using [advice from stackoverflow](http://stackoverflow.com/questions/359424/deta ...@@ -27,6 +27,42 @@ Using [advice from stackoverflow](http://stackoverflow.com/questions/359424/deta
TODO: TODO:
* add readme and license to the mathjax-docs repo & push to MathJax/mathjax-docs * add readme and license to the mathjax-docs repo & push to MathJax/mathjax-docs DONE
* switch themes on mathjax-docs to the sphinx-bootstrap theme with Peter's modification (Peter should fork the sphinx-bootstrap theme and make the modifications there) * switch themes on mathjax-docs to the sphinx-bootstrap theme with Peter's modification (Peter should fork the sphinx-bootstrap theme and make the modifications there) DONE
* redirect the old docs to the new docs, i.e., `mathjax.org/docs` to `docs.mathjax.org/en/` * redirect the old docs to the new docs, i.e., `mathjax.org/docs` to `docs.mathjax.org/en/`
\ No newline at end of file
Next issue: rtfd currently uses an outdated jquery which breaks the search.
Let's use github-pages in the mean time. And here's a build-script of sorts which will generate the entire docs. Run it, and then check the produced html, and then push it back to github.
```
#/bin/bash
cd /tmp
git clone https://github.com/mathjax/mathjax-docs.git
cd mathjax-docs
for remote in `git branch -r | grep -v master `; do git checkout --track $remote ; done
git checkout v1.0
sphinx-build . temp/en/v1.0/
git checkout v1.1-latest
sphinx-build . temp/en/v1.1-latest/
git checkout v2.0-latest
sphinx-build . temp/en/v2.0-latest/
git checkout master
sphinx-build . temp/en/latest/
git checkout gh-pages
rm -Rf "en/"
mv "temp/en" .
rmdir "temp"
rm -rf "en/latest/.doctrees"
rm -rf "en/v2.0-latest/.doctrees"
rm -rf "en/v1.1-latest/.doctrees"
rm -rf "en/v1.0/.doctrees"
rm -rf "en/latest/.buildinfo"
rm -rf "en/v2.0-latest/.buildinfo"
rm -rf "en/v1.1-latest/.buildinfo"
rm -rf "en/v1.0/.buildinfo"
```
gh-pages branch can be accessed via http://mathjax.github.com/mathjax-docs/en/latest/
That's more than we do right now, but not as much as the rtfd-badge gives... Will look if I can copy their design...
\ No newline at end of file
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