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

Add docs #328

Open
wants to merge 41 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
c39db6e
Quickstart docs, add mustache template
lahdjirayhan Dec 11, 2021
15eba41
Modify mustache file
lahdjirayhan Dec 12, 2021
df049bc
Update .gitignore to not track documentation builds
lahdjirayhan Dec 12, 2021
6979c5d
Delete build directory
lahdjirayhan Dec 12, 2021
a2d2750
Add initial documentation and docstring
lahdjirayhan Dec 12, 2021
ee09d9a
Add example/tutorial
lahdjirayhan Dec 12, 2021
80d1981
Merge branch 'master' into add-docs
lahdjirayhan Dec 12, 2021
a61347e
Update .gitignore to not track .vscode
lahdjirayhan Dec 14, 2021
aa38bf0
Modify my docstring to match owner expectation
lahdjirayhan Dec 14, 2021
2dade08
Rewrite index.rst
lahdjirayhan Dec 14, 2021
a844c45
Merge branch 'master' into add-docs
lahdjirayhan Dec 15, 2021
c2eabfb
Add examples
lahdjirayhan Dec 16, 2021
00e08d8
Add docstrings on Twitter module
lahdjirayhan Dec 16, 2021
b49fef6
Add docstrings on Instagram module
lahdjirayhan Dec 18, 2021
34cf780
Add docstrings on Telegram module
lahdjirayhan Dec 18, 2021
c62a9b4
Add docstring to Reddit module
lahdjirayhan Dec 18, 2021
4e2d184
Add docstring to VK module
lahdjirayhan Dec 18, 2021
a733e26
Fix docstring formatting
lahdjirayhan Dec 18, 2021
75b287b
Merge branch 'master' into backup-add-docs
lahdjirayhan Dec 26, 2021
ab1dbe9
Try autosummary
lahdjirayhan Dec 18, 2021
b5dcf41
Update .gitignore to not track autogenerated _autosummary
lahdjirayhan Dec 27, 2021
26fedeb
Add templates
lahdjirayhan Dec 27, 2021
44ca124
Slight fix
lahdjirayhan Dec 27, 2021
d2ba2c9
Modify template to remove double init in docs
lahdjirayhan Dec 27, 2021
319b575
Add docs to facebook module
lahdjirayhan Dec 28, 2021
ccbe847
Add docs in weibo module
lahdjirayhan Dec 28, 2021
59f69e5
Add docs to base Scraper class' get_items
lahdjirayhan Dec 28, 2021
294f6b7
Modify index.rst to have some toctree structure for entire package
lahdjirayhan Dec 28, 2021
ca5bf06
Merge branch 'master' into add-docs
lahdjirayhan Jan 5, 2022
c9a5c08
Update/add docstrings
lahdjirayhan Jan 15, 2022
845ff32
Merge branch 'master' into add-docs
lahdjirayhan Jan 15, 2022
a10a195
Update/add docstrings again
lahdjirayhan Jan 15, 2022
8e697a3
Add/update docs for mastodon objects
lahdjirayhan Jan 18, 2022
955bee8
Add/update docs for twitter
lahdjirayhan Jan 18, 2022
31d495e
Update .gitignore to not track venv folder
lahdjirayhan Jan 18, 2022
36f4d0e
Detect snscrape version in docs using importlib
lahdjirayhan Jan 18, 2022
2cb811b
Update index.rst to add mastodon
lahdjirayhan Jan 18, 2022
fe818fa
Fix incorrect docstring on TwitterTweetScraper
lahdjirayhan Jan 28, 2022
80627eb
Merge branch 'master' into add-docs
lahdjirayhan Feb 17, 2022
0eebb3b
Retrieve everything except project name from importlib.metadata
lahdjirayhan Feb 17, 2022
0832e95
Fix typo in index.rst
lahdjirayhan Feb 17, 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
Slight fix
The previous commit (copypaste template from SO)
has following behavior when tested on my local
device:

1. It generated all necessary stub .rst files
   under /_autosummary. (good)
2. It generated all HTMLs for each module,
    submodule, and class. (good)
3. (the bug) snscrape.modules page lists -- but
   does not link to any of -- its submodules.
	 The individual HTMLs for each submodule exist,
	 it is just not linked in toctree. I can open
	 each resulting HTML manually on my browser.

I've did some trial-and-error, this commit is
reflecting the minimal change that makes the
snscrape.modules page links to its submodules.
At least it works.
lahdjirayhan committed Dec 27, 2021
commit 44ca124ee884833a59dd3dbdad4d474d9fd829c8
2 changes: 1 addition & 1 deletion docs/_templates/custom-module-template.rst
Original file line number Diff line number Diff line change
@@ -60,7 +60,7 @@
:template: custom-module-template.rst
:recursive:
{% for item in modules %}
{{ item }}
{{ item.split('.')[-1] }}
{%- endfor %}
{% endif %}
{% endblock %}