Skip to content

Commit

Permalink
edit main docs page
Browse files Browse the repository at this point in the history
  • Loading branch information
erexer committed May 17, 2024
1 parent e3f8040 commit ea0dfb8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster'
html_theme = 'insegel'
html_theme_options = {
# Disable showing the sidebar. Defaults to 'false'
'nosidebar': True,
Expand Down
4 changes: 3 additions & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
# metarepo
`metarepo` is short for meta-repository, a GitHub repository that contains instructions to reproduce results in a published work. This repo is a template for creating your own metarepo.

[![Click here to use the metarepo template][](https://github.com/new?template_name=metarepo&template_owner=IMMM-SFA)]

## Purpose
A meta-repository creates a single point of access for someone to find all of the components that were used to create a published work for the purpose of reproducibility. This repository should contain references to all minted data and software as well as any ancillary code used to transform the source data, create figures for your publication, conduct the experiment, and / or execute the contributing software.

Expand All @@ -25,7 +27,7 @@ D. [Add a DOI to your metarepo](#d-add-a-doi-to-your-metarepo)
E. [Add your metarepo citation to your paper](#e-add-your-metarepo-citation-to-your-paper)

### A. Use the template to initialize your own meta-repo
Click `Use this template` on the main repository page (shows up above `Clone or download`) and click `Create a new repository`. Fill in your `Repository name` (naming conventions below), the `Description`, select whether you want the repository to be `Public` or `Private`, and leave `Include all branches` unchecked. Click `Create repository`. You'll be taken to the new repository you created.
Click `Use this template` on the [main repository page](https://github.com/IMMM-SFA/metarepo/) (shows up above `Clone or download`) and click `Create a new repository`. Fill in your `Repository name` (naming conventions below), the `Description`, select whether you want the repository to be `Public` or `Private`, and leave `Include all branches` unchecked. Click `Create repository`. You'll be taken to the new repository you created.

Note: The following naming conventions should be used when naming your repository:
- Single author: `lastname_year_journal`
Expand Down

0 comments on commit ea0dfb8

Please sign in to comment.