https://github.com/billbrod/sphinx-tutorial
Introduction to python docs sites.
Science Score: 26.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
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (5.4%) to scientific vocabulary
Repository
Introduction to python docs sites.
Basic Info
- Host: GitHub
- Owner: billbrod
- License: mit
- Language: CSS
- Default Branch: main
- Homepage: https://billbrod.github.io/sphinx-tutorial/
- Size: 25.4 KB
Statistics
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
sphinx-tutorial
Introduction to python docs sites.
To view presentation, run python -m http.server 8008 (or whatever port you want) in the root directory of this project, then open localhost:8008/sphinx-tutorial in your browser. Or go to https://billbrod.github.io/sphinx-tutorial/.
To build the sphinx documentation, create a new virtualenv and install this package (with docs requirements), then run sphinx:
sh
uv venv -p 3.12 venv
source venv/bin/activate
uv pip install -e .[docs]
make -C docs html -O="-T"
This will create the site in docs/build/html. You can open up the site in your browser (e.g., firefox docs/build/html/index.html).
Owner
- Name: William F. Broderick
- Login: billbrod
- Kind: user
- Location: New York, NY
- Company: Flatiron Institute
- Website: http://orcid.org/0000-0002-8999-9003
- Repositories: 5
- Profile: https://github.com/billbrod
Associate data scientist at Flatiron Institute, working to make computational neuroscience more open, cumulative, and reproducible.
GitHub Events
Total
- Push event: 3
Last Year
- Push event: 3
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| William F. Broderick | b****d@g****m | 13 |
Issues and Pull Requests
Last synced: 12 months ago
Dependencies
- actions/checkout v3 composite
- actions/configure-pages v3 composite
- actions/deploy-pages v4 composite
- actions/upload-pages-artifact v3 composite