https://github.com/adrn/rereadthedocs
Sentiment analysis of your documentation As A Service (tm).
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
2 of 5 committers (40.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (6.6%) to scientific vocabulary
Keywords
Repository
Sentiment analysis of your documentation As A Service (tm).
Basic Info
- Host: GitHub
- Owner: adrn
- License: mit
- Language: Jupyter Notebook
- Default Branch: main
- Size: 1.58 MB
Statistics
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
RereadTheDocs
Sentiment analysis of your documentation As A Service (tm).
This #AstroHackWeek community hack project uses documentation sentiment analysis via the python natural language toolkit (NLTK) package to analyze the astropy docs. Our goal is to use the results to improve astropy documentation and provide a tool for other software package developers to use more user-friendly language in their docs.
Some intermediary goals are: * Compare sentiments of subdocs of subpackages with in astropy to see if they are uniform (probably not!) and explore the differences * Use the results to poll Astro Hack Week participants and define what kinds of documentation language are the most user-friendly * Write a script that can run on any Sphinx documentation build to analyze user-friendliness * Based on the output of the script, provide concrete feedback to developers about how their documentation could be changed to be more user-friendly
Contributors
Adrian Price-Whelan @adrn, Meredith Rawls @mrawls, Ellie Schwab @elliesch, Brigitta Sipocz @bsipocz
Owner
- Name: Adrian Price-Whelan
- Login: adrn
- Kind: user
- Location: NYC
- Company: Flatiron Institute
- Website: adrian.pw
- Repositories: 124
- Profile: https://github.com/adrn
GitHub Events
Total
Last Year
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Meredith Rawls | m****s@u****u | 5 |
| Adrian Price-Whelan | a****w@g****m | 5 |
| Brigitta Sipocz | b****z@g****m | 4 |
| Ellie Schwab | e****b@g****m | 3 |
| elliesch | e****b@m****u | 1 |
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