-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DM-42023: Add documenteer technote add-author and sync-authors commands #205
Commits on Dec 5, 2023
-
Add interface to authordb.yaml file
The AuthorDb interface is based on one we wrote into lsst-sqre/lsst-templatebot-aide, and adapted to use requests. To improve on the latex encoding to unicode conversion, I'm adopting pylatexenc. This is a terrific package that replaces a lot of work that we'd used to to with pandoc or with fragile code of ours.
Configuration menu - View commit details
-
Copy full SHA for 1ef95b7 - Browse repository at this point
Copy the full SHA 1ef95b7View commit details
Commits on Dec 6, 2023
-
Configuration menu - View commit details
-
Copy full SHA for b25912d - Browse repository at this point
Copy the full SHA b25912dView commit details -
Configuration menu - View commit details
-
Copy full SHA for e6b43ed - Browse repository at this point
Copy the full SHA e6b43edView commit details
Commits on Dec 7, 2023
-
Add TechnoteTomlFile storage API
This class allows us to open and edit a technote.toml file, using preserved formatting. This is made possible by the tomlkit package. Notes on type checking: - Make use of typing casts to help mypy sort through ambiguous types - Use properties on the TechnoteTomlFile that take care of the casting
Configuration menu - View commit details
-
Copy full SHA for a6857e8 - Browse repository at this point
Copy the full SHA a6857e8View commit details -
This service-layer class will power functionality in the documenteer CLI. Right now it supports adding an author by ID from the authordb.yaml file, and synchronizing author information in a technote.toml file.
Configuration menu - View commit details
-
Copy full SHA for 7ca1ac4 - Browse repository at this point
Copy the full SHA 7ca1ac4View commit details -
Add a documenteer click-based CLI
This CLI will become the basis for future CL tooling from documenteer to help build and maintain documents.
Configuration menu - View commit details
-
Copy full SHA for 61c8e00 - Browse repository at this point
Copy the full SHA 61c8e00View commit details -
Add technote add-author CLI command
This command adds and updates authors from authordb.yaml.
Configuration menu - View commit details
-
Copy full SHA for 9b0695e - Browse repository at this point
Copy the full SHA 9b0695eView commit details
Commits on Dec 8, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 2f5f2e1 - Browse repository at this point
Copy the full SHA 2f5f2e1View commit details -
Handle case where orcid is null
TOML doesn't represent null values, so the appropriate action is to omit the orcid key entirely.
Configuration menu - View commit details
-
Copy full SHA for 1f704ea - Browse repository at this point
Copy the full SHA 1f704eaView commit details -
Configuration menu - View commit details
-
Copy full SHA for 95469cd - Browse repository at this point
Copy the full SHA 95469cdView commit details -
Switch to an inline table for authors
I can't get dotted keys to work, but an inline table is a good fit here.
Configuration menu - View commit details
-
Copy full SHA for c7cfb42 - Browse repository at this point
Copy the full SHA c7cfb42View commit details -
Add a TechnoteMigrationService
Right now this service migrates metadata.yaml content into technote.toml and updates index.rst to have a title, abstract, and References section.
Configuration menu - View commit details
-
Copy full SHA for 9d6479c - Browse repository at this point
Copy the full SHA 9d6479cView commit details
Commits on Dec 12, 2023
-
Add technote migrate CLI command
This command, documenteer technote migrate, should speed up the process of migrating from an original metadata.yaml-based technote to the new style. Using data from metadata.yaml, it sets up a new technote.toml file. It also migrates index.rst to the new requirements for title, abstract and bibliography. Finally, it also adds/overwrites key infrastructure files (ci.yaml, tox.ini, Makefile, etc). This migration command should accomplish 90% of the work for authors to migrate their technotes.
Configuration menu - View commit details
-
Copy full SHA for 884fc39 - Browse repository at this point
Copy the full SHA 884fc39View commit details -
Option to delete old files after migration
Add a documenteer technote migrate -D option file as well as an interactive prompt to delete the old metadata.yaml and .travis.yml files after a technote migration. People can always use git history to reset this history if run mistakenl.
Configuration menu - View commit details
-
Copy full SHA for 6767c00 - Browse repository at this point
Copy the full SHA 6767c00View commit details -
Add add-author and sync-authors commands
Add these to the Makefile and tox.ini used during the migration.
Configuration menu - View commit details
-
Copy full SHA for 6bc9e60 - Browse repository at this point
Copy the full SHA 6bc9e60View commit details -
Configuration menu - View commit details
-
Copy full SHA for 3872774 - Browse repository at this point
Copy the full SHA 3872774View commit details -
Use template files in migration documentation
This reduces the chances of errors
Configuration menu - View commit details
-
Copy full SHA for 2adcb94 - Browse repository at this point
Copy the full SHA 2adcb94View commit details -
Configuration menu - View commit details
-
Copy full SHA for be71f8c - Browse repository at this point
Copy the full SHA be71f8cView commit details