Skip to content
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

Twarc Tutorial #558

Merged
merged 22 commits into from
Dec 20, 2022
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
029f89c
Rework documentation and structure a bit to include a new tutorial se…
SamHames Oct 20, 2021
ecf47cd
Propose a skeleton structure for the tutorial
SamHames Oct 20, 2021
2200954
Cleanup the tutorial a little
SamHames Nov 29, 2021
83f62b3
First draft of the 'before we begin' section
SamHames Jan 17, 2022
2c37abb
More cleanup and moar words for the tutorial
SamHames Jan 24, 2022
2a9ae9b
Flesh out more of the actual search content
SamHames Feb 3, 2022
a617115
Update the data processing to avoid working with excel at all
SamHames Feb 8, 2022
65c5a6a
Incorporate more of the counts/search workflow as an interative approach
SamHames Feb 8, 2022
28cf9d6
Flesh out the search/counts worked example, cleanup some todos
SamHames Feb 9, 2022
17ae42d
Rearrange sections based on the suggestion [ci skip]
SamHames Feb 11, 2022
d0aaa0d
Make the research question more concrete
SamHames Feb 11, 2022
870f3f3
Link to existing resources section of the twarc docs [ci skip]
SamHames Feb 11, 2022
b566fc6
Add module installation to documentation local development instructions
betsybookwyrm May 23, 2022
0a4a0d9
Tutorial: Fill out API explainer section
betsybookwyrm May 23, 2022
ec3a257
Flesh out Intro to Twitter API tutorial section
betsybookwyrm Jul 15, 2022
cce8488
Minor proofreading fixes for tutorial
betsybookwyrm Oct 10, 2022
7cf5943
Require mkdocstrings[python] for docs building
betsybookwyrm Oct 10, 2022
52289d2
Explain API versions
betsybookwyrm Oct 10, 2022
e360879
Merge branch 'tutorial' of github.com:boyd-nguyen/twarc into tutorial
boyd-nguyen Nov 11, 2022
11f4dc8
added screenshots + editted code blocks + fixed minor typos
boyd-nguyen Nov 11, 2022
2432ec3
Merge pull request #665 from boyd-nguyen/tutorial
SamHames Nov 11, 2022
ece130f
Apply suggestions from code review
igorbrigadir Dec 15, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add module installation to documentation local development instructions
Add `pip install -e .` step to readme instructions for running local
documentation server
  • Loading branch information
betsybookwyrm committed Oct 10, 2022
commit b566fc6e2b52788d396f352402a4acc777b3edd9
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -29,6 +29,7 @@ The documentation is managed at ReadTheDocs. If you would like to improve the do
To view your documentation locally you should be able to:

pip install -r requirements-mkdocs.txt
pip install -e .
mkdocs serve
open http://127.0.0.1:8000/