Skip to content
Snippets Groups Projects

pytest and documentation

Merged Lee McCuller requested to merge lee-mcculler/pygwinc:pytest_and_docs into master
3 unresolved threads

Added three things:

  • pytest support: using my (moderately documented) canonical set of pytest fixtures
  • documentation folder: boilerplate documentation and setup taken from dttxml, to be filled in a bit more primarily with apidoc using sphinx-autodoc

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Jameson Rollins
  • Lee McCuller added 2 commits

    added 2 commits

    Compare with previous version

  • Lee McCuller resolved all threads

    resolved all threads

  • Lee McCuller added 1 commit

    added 1 commit

    • c1ec5312 - cleaned up docs version and fixed markup in a pytest fixture

    Compare with previous version

  • 62 69 # built documents.
    63 70 #
    64 71 # The short X.Y version.
    65 version = '0.0.0'
    72 version = gwinc.__version__
  • 116 #html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
    105 117
    106 118 #import jupyter_sphinx_theme
    107 119 #html_theme = "jupyter_sphinx_theme"
    108 120 #html_theme_path = [jupyter_sphinx_theme.get_html_theme_path()]
    109 121
    110 #html_theme = "alabaster"
    122 html_theme = "alabaster"
    111 123
    112 124 # Theme options are theme-specific and customize the look and feel of a theme
    113 125 # further. For a list of options available for each theme, see the
    114 126 # documentation.
    115 127 #
    116 # html_theme_options = {}
    128 html_theme_options = dict(
    129 description = "Gravitational Wave Interferometer Noise Calculator, to determine the fundamental limiting noises in interferometer designs",
  • @lee-mcculler can you add some CI to build the docs?

  • Jameson Rollins approved this merge request

    approved this merge request

  • Jameson Rollins mentioned in commit 7c146498

    mentioned in commit 7c146498

  • Kevin Kuns mentioned in merge request !135 (merged)

    mentioned in merge request !135 (merged)

  • Please register or sign in to reply
    Loading