Skip to content

Commit

Permalink
Docs front page (#123)
Browse files Browse the repository at this point in the history
* Fix annotation propagation when folding a map

* Update dependencies versions

* Pytezos landing page: screenshots

* Add custom front page, move to pytezos.org
  • Loading branch information
m-kus authored Sep 14, 2020
1 parent acf644a commit 217fdd0
Show file tree
Hide file tree
Showing 16 changed files with 65 additions and 35 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ docker pull bakingbad/pytezos
Read [quick start guide](https://pytezos.baking-bad.org/quick_start.html)

### API reference
Check out a complete [API reference](https://pytezos.baking-bad.org)
Check out a complete [API reference](https://pytezos.baking-bad.org/contents.html)

#### Inline documentation
If you are working in Jupyter/Google Colab or any other interactive console,
Expand Down
Binary file added docs/source/_static/img/atomex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/img/bb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/img/chorus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/img/equisafe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/img/favicon.ico
Binary file not shown.
Binary file added docs/source/_static/img/pytezos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/img/pytezos_interacting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/img/pytezos_kernel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/img/pytezos_testing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/_static/img/tqtezos.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/source/_static/img/tzero.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
import sys
sys.path.insert(0, os.path.abspath('../..'))


# -- Project information -----------------------------------------------------

project = 'PyTezos'
Expand All @@ -39,6 +38,8 @@
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

master_doc = 'contents'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand All @@ -65,14 +66,18 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_additional_pages = {'index': 'index.html'}


# -- Extension configuration -------------------------------------------------

googleanalytics_id = 'UA-160856677-2'

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

html_baseurl = 'https://pytezos.baking-bad.org/'
html_baseurl = 'https://pytezos.org/'
html_extra_path = ['robots.txt']
html_favicon = 'favicon.ico'
2 changes: 1 addition & 1 deletion docs/source/index.rst → docs/source/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PyTezos documentation!
Welcome to PyTezos reference!
===================================

.. title:: Baking Bad
Expand Down
72 changes: 42 additions & 30 deletions poetry.lock

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "pytezos"
version = "2.5.7"
version = "2.5.8"
description = "Python toolkit for Tezos"
license = "MIT"
authors = ["Michael Zaikin <[email protected]>", "Arthur Breitman", "Roman Serikov"]
Expand Down Expand Up @@ -39,6 +39,7 @@ pytest-cov = "^2.4"
sphinx = "*"
sphinx_rtd_theme = { git = "https://github.com/readthedocs/sphinx_rtd_theme.git", tag = "0.5.0rc2" }
sphinx-sitemap = "*"
sphinxcontrib-googleanalytics = "^0.1"

[tool.poetry.scripts]
pytezos = 'pytezos:cli.main'
Expand Down

0 comments on commit 217fdd0

Please sign in to comment.