Merge pull request #558 from DocNow/tutorial

Twarc Tutorial
DocNow · Dec 20, 2022 · 57c7cb2 · 57c7cb2
2 parents a29b45a + ece130f
commit 57c7cb2
Show file tree

Hide file tree

Showing 16 changed files with 443 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -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/
 

diff --git a/docs/README.md b/docs/README.md
@@ -26,4 +26,4 @@ For `R` there is [academictwitteR](https://cran.r-project.org/web/packages/acade
 
 ## Getting Help
 
-Check the [tutorials](tutorials.md) to get started, or follow along with this [recorded stream](https://tube.nocturlab.fr/videos/watch/1d98d20e-a4fd-4594-aa94-9b1b1301cead) introducing twarc. If you run into trouble, feel free to make a post on the [Twarc Repository](https://github.com/DocNow/twarc/issues) or on the [Twitter Developer Forums](https://twittercommunity.com/c/academic-research/62).
+Check out the [tutorial](tutorial.md) to get started, or follow along with this [recorded stream](https://tube.nocturlab.fr/videos/watch/1d98d20e-a4fd-4594-aa94-9b1b1301cead) introducing twarc. You can also find additional resources linked from [resources](resources.md). If you run into trouble, feel free to make a post on the [Twarc Repository](https://github.com/DocNow/twarc/issues) or on the [Twitter Developer Forums](https://twittercommunity.com/c/academic-research/62).
diff --git a/docs/images/CMD.png b/docs/images/CMD.png
diff --git a/docs/images/echidna_csv.png b/docs/images/echidna_csv.png
diff --git a/docs/images/excel_echidna.png b/docs/images/excel_echidna.png
diff --git a/docs/images/json_echidna.png b/docs/images/json_echidna.png
diff --git a/docs/images/pip_install.png b/docs/images/pip_install.png
diff --git a/docs/images/twarc_configure.png b/docs/images/twarc_configure.png
diff --git a/docs/images/twarc_count_echidna.png b/docs/images/twarc_count_echidna.png
diff --git a/docs/images/twarc_help.png b/docs/images/twarc_help.png
diff --git a/docs/images/twarc_progress_download.png b/docs/images/twarc_progress_download.png
diff --git a/docs/images/win_installer.png b/docs/images/win_installer.png
diff --git a/docs/tutorials.md → docs/resources.md b/docs/tutorials.md → docs/resources.md
@@ -1,6 +1,6 @@
-# Twarc Tutorials
+# Twarc Tutorials and Other Resources
 
-Documentation here is largely auto generated from the code, which may not always be the most user friendly. Others have written great totorials on using twarc, and these are linked here.
+Documentation here is largely auto generated from the code, which may not always be the most user friendly. Others have written great tutorials and other resources relating to using twarc, or working with the data generated by twarc. If you'd like to suggest additional resources that are relevant, please feel to open a pull request or open an issue.
 
 ## UVA Library's Scholars' Lab Twarc Tutorial
 

diff --git a/docs/tutorial.md b/docs/tutorial.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -25,7 +25,8 @@ nav:
  - twarc1 (sw): twarc1_sw_ke.md
  - twarc1 (zw): twarc1_zw_zh.md
  - Plugins: plugins.md
- - Tutorials: tutorials.md
+ - Tutorial: tutorial.md
+ - Resources: resources.md
  - Twitter Developer Access: twitter-developer-access.md 
  - Windows 10: windows10.md
  - Library API:

diff --git a/requirements-mkdocs.txt b/requirements-mkdocs.txt
@@ -8,4 +8,4 @@ tqdm>=4.62
 mkdocs>=1.2
 mkdocs-click>=0.4
 mkdocs-material>=7.2
-mkdocstrings>=0.15
+mkdocstrings[python]>=0.15