docs-snippets
A collection of common documentation configuration files.
Science Score: 54.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
-
○Academic publication links
-
✓Committers with academic emails
1 of 1 committers (100.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.5%) to scientific vocabulary
Repository
A collection of common documentation configuration files.
Basic Info
- Host: GitHub
- Owner: kevinmatthes
- License: gpl-2.0
- Language: MATLAB
- Default Branch: main
- Size: 326 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
docs-snippets
Summary
A collection of common documentation configuration files.
License
This project's license is GPL 2 (as of June 1991). The whole license text
can be found in LICENSE in the main directory of this repository. The brief
version is as follows:
Copyright (C) 2022 Kevin Matthes
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
When compiling a printable version of this documentation using Pandoc, the full
license will be attached automatically to the resulting document. This can be
invoked by calling repository-manual.m.
Software Requirements
This repository does not contain any source code, so there are no major software requirements. However, it is possible to compile a printable description of the repository's READMEs as well as the LICENSE. Therefore, one needs to ensure the installation of the applications and packages listed in the following.
| Requirement | Type | Role |
|:------------------|:-------------:|:----------------------------------|
| GNU Octave | application | execution of the provided scripts |
| Pandoc | application | compilation of repository manual |
| texlive-full | package | compilation of repository manual |
The compilation of such an optional repository manual can be invoked by just calling one of the following lines in a terminal.
octave repository-manual.m
octave-cli repository-manual.m
Both will redirect to the same application, GNU Octave, which will then create
the manual for this repository and attach the entire license to it. The
resulting file, repository.pdf, will be saved in the main directory of this
repository.
Description
Any good project should have at least a reasonable minimum of description. Therefore, plenty of automatic documentation creation were developed in order to make the process of writing a manual easier. Many of those are specific to one certain language, such as Haddock for Haskell or JavaDoc for Java. Some even support multiple languages like Doxygen does for C-like languages.
All of the systems have in common that they generate the intended documentation from the source code of the project, evaluating some certain comments placed in there. Furthermore, they might be instructed to mind certain settings when writing the documentation; one of the most common settings therefore is the actual output directory. Systems like Haddock and JavaDoc accept such settings as command line arguments when called, Doxygen, in contrast, reads the preferences from a configuration file.
Not only these configurations, no matter if processed whether by command line arguments or by configuration files, but also the documenting comments, often named "docstrings", will produce redundancy since most of the content will be equal for numerous projects.
The purpose of this repository is it therefore to provide some frequently used configuration settings and docstring patterns for several languages and documentation systems. They can be considered sample templates but also be adjusted to the needs of a certain project and / or repository which binds this one as a submodule.
Owner
- Name: Kevin Matthes
- Login: kevinmatthes
- Kind: user
- Repositories: 16
- Profile: https://github.com/kevinmatthes
Citation (CITATION.cff)
######################## GNU General Public License 2.0 ########################
## ##
## Copyright (C) 2022 Kevin Matthes ##
## ##
## This program is free software; you can redistribute it and/or modify ##
## it under the terms of the GNU General Public License as published by ##
## the Free Software Foundation; either version 2 of the License, or ##
## (at your option) any later version. ##
## ##
## This program is distributed in the hope that it will be useful, ##
## but WITHOUT ANY WARRANTY; without even the implied warranty of ##
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ##
## GNU General Public License for more details. ##
## ##
## You should have received a copy of the GNU General Public License along ##
## with this program; if not, write to the Free Software Foundation, Inc., ##
## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. ##
## ##
################################################################################
################################################################################
##
## AUTHOR Kevin Matthes
## BRIEF Citation settings for the Git repository.
## COPYRIGHT (C) 2022 Kevin Matthes.
## This file is licensed GPL 2 as of June 1991.
## DATE 2022
## FILE CITATION.cff
## NOTE See `LICENSE' for full license.
## See `README.md' for project details.
##
################################################################################
# Parser settings.
cff-version: 1.2.0
message: Please cite this software using these meta data.
# Version information.
date-released: 2022-05-14
version: 0.0.0
# Project information.
abstract: A collection of common documentation configuration files.
authors:
- family-names: Matthes
given-names: Kevin
license: GPL-2.0
repository-artifact: https://github.com/kevinmatthes/docs-snippets
title: docs-snippets
url: https://github.com/kevinmatthes/docs-snippets
# Preferred citation.
preferred-citation:
abstract: A collection of common documentation configuration files.
authors:
- family-names: Matthes
given-names: Kevin
date-released: 2022-05-14
license: GPL-2.0
repository-artifact: https://github.com/kevinmatthes/docs-snippets
title: docs-snippets
type: software-code
url: https://github.com/kevinmatthes/docs-snippets
version: 0.0.0
# References.
references:
- type: standard
abstract: CITATION.cff files are plain text files with human- and machine-readable citation information for software. Code developers can include them in their repositories to let others know how to correctly cite their software. This is the specification for the Citation File Format.
authors:
- family-names: Druskat
given-names: Stephan
orcid: https://orcid.org/0000-0003-4925-7248
- family-names: Spaaks
given-names: Jurriaan H.
orcid: https://orcid.org/0000-0002-7064-4069
- family-names: Chue Hong
given-names: Neil
orcid: https://orcid.org/0000-0002-8876-7606
- family-names: Haines
given-names: Robert
orcid: https://orcid.org/0000-0002-9538-7919
- family-names: Baker
given-names: James
orcid: https://orcid.org/0000-0002-2682-6922
- family-names: Bliven
given-names: Spencer
orcid: https://orcid.org/0000-0002-1200-1698
email: spencer.bliven@gmail.com
- family-names: Willighagen
given-names: Egon
orcid: https://orcid.org/0000-0001-7542-0286
- family-names: Pérez-Suárez
given-names: David
orcid: https://orcid.org/0000-0003-0784-6909
website: https://dpshelio.github.io
- family-names: Konovalov
given-names: Alexander
orcid: https://orcid.org/0000-0001-5299-3292
title: Citation File Format
version: 1.2.0
identifiers:
- type: doi
value: 10.5281/zenodo.1003149
description: The concept DOI for the collection containing all versions of the Citation File Format.
- type: doi
value: 10.5281/zenodo.5171937
description: The versioned DOI for the version 1.2.0 of the Citation File Format.
date-released: "2021-08-09"
keywords:
- citation file format
- CFF
- citation files
- software citation
- file format
- YAML
- software sustainability
- research software
- credit
license: "CC-BY-4.0"
doi: 10.5281/zenodo.5171937
- type: software
abstract: Command line program to validate and convert CITATION.cff files.
authors:
- affiliation: Netherlands eScience Center
family-names: Spaaks
given-names: Jurriaan H.
orcid: https://orcid.org/0000-0002-7064-4069
- affiliation: Netherlands eScience Center
family-names: Klaver
given-names: Tom
- affiliation: Netherlands eScience Center
family-names: Verhoeven
given-names: Stefan
orcid: https://orcid.org/0000-0002-5821-2060
- affiliation: Humboldt-Universität zu Berlin
family-names: Druskat
given-names: Stephan
orcid: https://orcid.org/0000-0003-4925-7248
- affiliation: University of Oslo
family-names: Leoncio
given-names: Waldir
name-suffix: Netto
date-released: 2021-09-22
identifiers:
- type: doi
value: 10.5281/zenodo.1162057
description: Persistent identifier for all versions of cffconvert
- type: doi
value: 10.5281/zenodo.5521767
description: Persistent identifier for this version of cffconvert
- type: url
value: https://github.com/citation-file-format/cff-converter-python
description: URL to the GitHub repository for cffconvert
- type: url
value: https://pypi.org/project/cffconvert
description: cffconvert on PyPI
keywords:
- bibliography
- BibTeX
- cff
- citation
- CITATION.cff
- CodeMeta
- EndNote
- RIS
- Citation File Format
license: Apache-2.0
repository-artifact: https://pypi.org/project/cffconvert
repository-code: https://github.com/citation-file-format/cff-converter-python
title: cffconvert
version: 2.0.0
- type: software-code
title: Ruby CFF Library
abstract: This library provides a Ruby interface to manipulate Citation File Format files
authors:
- family-names: Haines
given-names: Robert
orcid: https://orcid.org/0000-0002-9538-7919
affiliation: The University of Manchester, UK
- name: The Ruby Citation File Format Developers
keywords:
- ruby
- credit
- software citation
- research software
- software sustainability
- metadata
- citation file format
- CFF
version: 0.9.0
doi: 10.5281/zenodo.1184077
date-released: 2021-08-18
license: Apache-2.0
repository-artifact: https://rubygems.org/gems/cff
repository-code: https://github.com/citation-file-format/ruby-cff
- type: manual
title: "GNU Octave version 7.1.0 manual: a high-level interactive language for numerical computations"
authors:
- family-names: Eaton
given-names: John W.
- family-names: Bateman
given-names: David
- family-names: Hauberg
given-names: "Søren"
- family-names: Wehbring
given-names: Rik
year: 2022
url: https://www.gnu.org/software/octave/doc/v7.1.0/
################################################################################
GitHub Events
Total
Last Year
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Kevin Matthes | k****s@s****e | 162 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0