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
  • Merge requests
  • !319

Add make watch to documentation

  • Review changes

  • Download
  • Patches
  • Plain diff
Merged Bruno de Paula Kinoshita requested to merge add-make-watch into master Feb 17, 2023
  • Overview 5
  • Commits 1
  • Pipelines 0
  • Changes 2

I use this in other Python projects to make writing the documentation faster & easier.

Basically, after installing all dependencies in requirements.txt, instead of having to build and then open or serve the docs from the build directory, after this MR the make watch command can be used to:

  1. start a web server for the documentation at http://localhost:8000
  2. re-build the HTML if anything in the documentation sources change (i.e. if you edit any .rst file, for instance)

This way you can just keep a tab open in the served page, edit in another monitor, and it should automagically refresh for you (or you press F5).

-Bruno

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: add-make-watch