Data

Tools

Indexes

Applications

Experiments

Open Source Science

documentation

How to document your research software

https://github.com/coderefinery/documentation

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (2.6%) to scientific vocabulary

Keywords

carpentry-lesson documentation readthedocs sphinx-doc
Last synced: 6 months ago · JSON representation ·

Repository

How to document your research software

Basic Info
Statistics
  • Stars: 31
  • Watchers: 13
  • Forks: 51
  • Open Issues: 13
  • Releases: 2
Topics
carpentry-lesson documentation readthedocs sphinx-doc
Created about 9 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

How to document your research software

Owner

  • Name: coderefinery
  • Login: coderefinery
  • Kind: organization
  • Email: support@coderefinery.com

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this lesson material, please cite it using these metadata."
authors:
- name: "CodeRefinery"
- family-names: "Bast"
  given-names: "Radovan"
- family-names: "Darst"
  given-names: "Richard"
- family-names: "Lindi"
  given-names: "Bjørn"
- family-names: "Negru"
  given-names: "Stefan"
- family-names: "Orozco"
  given-names: "Luisa"
- family-names: "Rantaharju"
  given-names: "Jarno"
- family-names: "Rasel"
  given-names: "Annajiat Alim"
- family-names: "Razick"
  given-names: "Sabry"
- family-names: "van der Burg"
  given-names: "Sven"
- family-names: "van Vliet"
  given-names: "Marijn"
- family-names: "Wikfeldt"
  given-names: "Kjartan Thor"
- family-names: "Wittke"
  given-names: "Samantha"
title: "How to document your research software"
type: "dataset"
abstract: "The lesson 'How to document your research software' gives an overview of the different ways how a code project can be documented: from small projects to larger projects. Markdown and Sphinx are central tools in this lesson."
version: 2023-08-24
doi: "https://doi.org/10.5281/zenodo.8280234"
date-released: 2023-08-24
url: "https://coderefinery.github.io/documentation/"
license: CC-BY-4.0
repository-code: "https://github.com/coderefinery/documentation"

GitHub Events

Total
  • Issues event: 6
  • Watch event: 7
  • Delete event: 3
  • Issue comment event: 7
  • Push event: 17
  • Pull request event: 6
  • Fork event: 3
  • Create event: 2
Last Year
  • Issues event: 6
  • Watch event: 7
  • Delete event: 3
  • Issue comment event: 7
  • Push event: 17
  • Pull request event: 6
  • Fork event: 3
  • Create event: 2

Dependencies

requirements.txt pypi
  • sphinx-lesson *
  • sphinx_rtd_theme *
  • sphinx_rtd_theme_ext_color_contrast *
.github/workflows/spellcheck.yml actions
  • actions/checkout v1 composite
.github/workflows/sphinx.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • ammaraskar/sphinx-problem-matcher master composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/validate-cff.yml actions
  • actions/checkout v3 composite
  • dieghernan/cff-validator main composite