Skip to content

GitLab

  • Menu
Projects Groups Snippets
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • N NIFTy
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 17
    • Issues 17
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 12
    • Merge requests 12
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Releases
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • ift
  • NIFTy
  • Merge requests
  • !761

Merged
Created Apr 07, 2022 by Vincent Eberle@veberleMaintainer3 of 3 tasks completed3/3 tasks

Restructure Docs

  • Overview 20
  • Commits 25
  • Pipelines 13
  • Changes 4

Changes in Readme

I fixed some broken links, e.g.: the mpi4py link and one link the a code section on git were broken)

Changes in the generated docs

  • how to generate the docs was stated twice (user/installation and dev/index) and once the dependencies were incomplete
  • IMHO installation for developers should be part of dev-section (to keep it ease to find the installation guide I put in a link from installation to dec/index
  • plotting, mpi4py, etc are also used by non developers, so I moved the section to the user installation

Further suggestions

  • moving the section on installation of mpi4py and matplotlib in the README file as well
  • installation guide for astropy, h5py (or a link), in order to keep it the way we do it for other opt. dependencies
  • putting in or changing the developer section to the way most of us install nifty etc. (cloning repo, pip install --user -e .,) since also new group members use these instructions. (I think this would decrease some overhead)

@parras @mtr what do you think?

Edited Apr 14, 2022 by Philipp Arras
Assignee
Assign to
Reviewer
Request review from
Time tracking
Source branch: fix_links_and_typos