Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
D
dorie
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 31
    • Issues 31
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 9
    • Merge Requests 9
  • Operations
    • Operations
    • Incidents
    • Environments
  • Analytics
    • Analytics
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
  • dorie
  • dorie
  • Issues
  • #10

Closed
Open
Opened Apr 05, 2017 by Lukas Riedel@lriedel🛀Owner

Sphinx documentation is broken

The update to Dune v2.5 broke the Sphinx documentation. Apparently, the new Dune macros use a new syntax. At the moment, make doc produces a documentation of the entire CMake API included in Dorie.

Solution: Explicitly call Sphinx via CMake like in this example Use the macro with the new syntax as it is done in dune-testtools.

Preliminary tasks:

  • create new conf.py.in file using sphinx-quickstart
  • install Sphinx into the Dune venv
    • execute Sphinx inside Dune venv when calling make doc or similar
  • change syntax of dune_cmake_sphinx_doc()
  • check Breathe functionality
Edited Nov 06, 2017 by Lukas Riedel
To upload designs, you'll need to enable LFS and have admin enable hashed storage. More information
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: dorie/dorie#10