Skip to content

Commit

Permalink
Updates to the template (#25)
Browse files Browse the repository at this point in the history
* add mac to gitignore

* removed unused tox settings

* added theming to docs

* removed unused logger configuration
  • Loading branch information
ehsteve committed Jan 5, 2023
1 parent edc84fd commit eb7472a
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 96 deletions.
30 changes: 30 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -150,3 +150,33 @@ docs/api
docs/whatsnew/latest_changelog.txt
hermes_{{ cookiecutter.instr_name }}/version.py
htmlcov/

# macOS.gitignore

# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
18 changes: 18 additions & 0 deletions hermes_{{ cookiecutter.instr_name }}/docs/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

div.related ul{
background-color:#182751 !important;
}

div.sphinxsidebar h4{
border: 1px solid 182751;
background-color: #182751;
}

div.sphinxsidebar h3{
border: 1px solid 182751;
background-color: #182751;
}

h1, h2, h3 {
color:#b21f2b;
}
10 changes: 8 additions & 2 deletions hermes_{{ cookiecutter.instr_name }}/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
# -- Project information -----------------------------------------------------

project = "hermes_{{ cookiecutter.instr_name }}"
copyright = "2021, Jane Doe"
author = "Jane Doe"
copyright = ""
author = "The HERMES Team"

# The full version, including alpha/beta/rc tags
from hermes_{{ cookiecutter.instr_name }} import __version__
Expand Down Expand Up @@ -104,7 +104,13 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "bizstyle"
html_static_path = ["_static"]

html_logo = "logo/hermes_logo.png"
html_favicon = "logo/favicon.ico"
html_css_files = [
"css/custom.css",
]
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand Down
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -22,34 +22,3 @@ time_format = %Y-%m-%d %H:%M:%S
; SunPy working directory.
; Default value: data/
download_dir = data

;;;;;;;;;;;;
; Logger ;
;;;;;;;;;;;;
[logger]

# Threshold for the logging messages. Logging messages that are less severe
# than this level will be ignored. The levels are 'DEBUG', 'INFO', 'WARNING',
# 'ERROR'
log_level = INFO

# Whether to use color for the level names
use_color = True

# Whether to log warnings.warn calls
log_warnings = True

# Whether to log exceptions before raising them
log_exceptions = True

# Whether to always log messages to a log file
log_to_file = True

# The file to log messages to
log_file_path = hermes.log

# Threshold for logging messages to log_file_path
log_file_level = INFO

# Format for log file entries
log_file_format = %(asctime)s, %(origin)s, %(levelname)s, %(message)s
63 changes: 0 additions & 63 deletions hermes_{{ cookiecutter.instr_name }}/tox.ini

This file was deleted.

0 comments on commit eb7472a

Please sign in to comment.