icesat2py/icepyx

custom bib entry labeling with pybtex

Open

#146 opened on Oct 30, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (119 forks)auto 404
documentationenhancementhelp wanted

Repository metrics

Stars
 (256 stars)
PR merge metrics
 (PR metrics pending)

Description

We use the sphinx extension for bibtex to include references in our documentation. The extension (sphinxcontrib.bibtex) uses pybtex under the hood to parse and format the bibtex entries. It would be great if we could customize the labels that are used for each reference entry (or remove them), but the pybtex examples are thin on how to control what bibtex entry field is used for the label or how to customize it.

Contributor guide

Research direction
Investigate sphinxcontrib.bibtex source code and pybtex label generation to find how to customize or remove labels for bib entries.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65