Alexander Graf
e9cec0b261
docs/conf.py: remove unneeded import
2018-12-31 19:35:55 +01:00
Alexander Graf
ac4cd9f595
New doc design: Sphinx Bootstrap 4 Theme
...
Now we use an own, mobile-first, responsive sphinx theme based on Bootstrap 4.
It makes navigation on the very long "Python module instaloader" page a lot
easier. Also, it looks better.
This solves all the problems we had with sphinx-bootstrap-theme.
2018-12-31 19:30:19 +01:00
Alexander Graf
1ab9e44104
Update sphinx_autodoc_typehints to version 1.5.2
2018-12-13 16:23:14 +01:00
Alexander Graf
ae492ed68b
New doc section: codesnippets / Advanced Examples
...
Presents code examples that use the instaloader module for more advanced tasks
than what is possible with the Instaloader command line interface.
Presents #46 , #56 , #110 , #113 , #120 , #121 .
2018-06-04 11:57:28 +02:00
Alexander Graf
7edc69454d
doc: Fix links to Instaloader classes
2018-04-28 19:50:14 +02:00
Alexander Graf
2c50972e08
Update as-module.rst and docstrings
2018-04-28 15:47:04 +02:00
Alexander Graf
b9ac40899d
Theme-related Documentation Enhancements
...
- Consistent background color in all types of codes
- Improve dd (list item) padding
- Link to Index in global TOC in navbar
- Briefly describe Instaloader in `index.html` title
- Remove page contents (navbartoc) in index, genindex and installation
- Link to new pypi.org rather than old pypi.python.org
2018-04-28 15:47:04 +02:00
Alexander Graf
235522dfd7
Merge branch 'master' into v4-dev
2018-03-31 15:06:39 +02:00
Alexander Graf
d533c60824
doc: Switch to mobile-friendlier bootstrap theme
...
It seems to be better supported than Alabaster and is easier to be
configured to look good on both a phone and a desktop.
2018-03-28 19:39:58 +02:00
Alexander Graf
539273b963
make doc more mobile-friendly
2018-03-24 21:47:35 +01:00
Alexander Graf
4a944fbbdb
doc: meta tag to redirect to new documentation URL
2018-03-24 11:32:53 +01:00
Alexander Graf
4a2e32790a
Minor documentation improvements
...
- List all __init__ methods in documentation
- Further describe purpose of Profile in its docstring
2018-03-18 17:19:22 +01:00
Alexander Graf
68d8f65cb9
Add logo in documentation sidebar
2018-03-14 22:14:24 +01:00
Alexander Graf
e77c998a94
Invent beautiful logo and use it as doc favicon
2018-03-14 19:09:24 +01:00
Alexander Graf
92114f9018
Add message on instaloader.rtfd.io that doc moved
2018-03-13 16:58:00 +01:00
Alexander Graf
4e57ac77f0
docs: Obtain current tag via git instead of gh api
2018-03-13 14:03:49 +01:00
Alexander Graf
9b60adeb45
Adjust github repo references
...
New repo URL: https://github.com/instaloader/instaloader
2018-03-13 13:29:44 +01:00
Alexander Graf
5695bca9f3
Current version and release date in doc sidebar
2017-12-21 13:53:06 +01:00
Alexander Graf
9a72f85a0e
Documentation Enhancements
2017-09-08 10:35:38 +02:00
Alexander Graf
e143096140
Minor documentation fixes
2017-08-29 12:13:38 +02:00
Alexander Graf
1f89dba702
Minor Sphinx theme switch
...
(The links sidebar was not shown on readthedocs.io)
2017-08-25 22:46:36 +02:00
Alexander Graf
90c5cc3c72
Minor documentation tunings
2017-08-25 22:38:54 +02:00
Alexander Graf
d7b1e2002d
Avoid unicode character in docs/conf.py
...
(caused problems on readthedocs)
2017-08-25 19:41:35 +02:00
Alexander Graf
ec2e09edcf
Create minimal documentation with Sphinx
2017-08-25 16:54:36 +02:00
