Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • autosubmit autosubmit
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 338
    • Issues 338
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 21
    • Merge requests 21
  • Deployments
    • Deployments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Earth SciencesEarth Sciences
  • autosubmitautosubmit
  • Issues
  • #878
Closed
Open
Issue created Sep 29, 2022 by Bruno de Paula Kinoshita@bdepaulaMaintainer

[documentation] Preview the documentation or merge requests with ReadTheDocs

ReadTheDocs, besides building and hosting documentation, also offers preview of builds. This means that if you have a ongoing work on the documentation, you should be able to preview the website with your changes. That's useful for users contributing for the first time, and not familiar with the syntax, and also for developers to collaborate on the docs.

I have used it with GitHub, but their documentation states: “Only available for GitHub and GitLab currently. Bitbucket is not yet supported.”: https://docs.readthedocs.io/en/stable/pull-requests.html

After RTD builds the Sphinx documentation, the preview URL follows this pattern: https://{PROJECT_NAME}--{PULL_REQUEST_NUMBER}.org.readthedocs.build/en/${PULL_REQUEST_NUMBER}/index.html

New commits trigger new builds, and the preview is updated within seconds or minutes. Here's an example project that uses it:

  • https://github.com/common-workflow-language/cwltool/blob/main/.readthedocs.yml
Assignee
Assign to
Time tracking