dash-tf-docset

Dash DocSet for TensorFlow 2.x and 1.x

View TensorFlow docs in the dash/zeal offline docset browser.

To use, you can add this feed in Dash/Zeal:

https://raw.githubusercontent.com/m3hrdadfi/dash-tf-docset/master/TensorFlow.xml

Or download the latest release here.

Installation:

pip install -r requirements.txt

Supported versions/Pre-requisites.

Python
3.6
3.7
3.8

Usage:

The code handles both manual and auto-generating techniques. Before going any further install Dashing Generator by Technosophos

Manual

In the manual section, you can generate the Dash DocSet for your TensorFlow version which created by Contribute to the TensorFlow documentation in markdown format by the following templates:

python gen.py -i {DIR_PATH} -o {DIR_PATH} -v {TENSORFLOW_VERSION}

The sample command for generating DocSet for TensorFlow v1.13.0 in ./v1.13.0/html in which already made in markdown format in ./v1.13.0/markdown:

python gen.py -i ./v1.13.0/markdown ./v1.13.0/html -v 1.13.0

Automatically

In the automatic plan, you can generate your specific version of TensorFlow for your Dash DocSet using this command

python gen2.py -d {DIR_PATH} -v {TENSORFLOW_VERSION}

The sample command for generating DocSet for TensorFlow v2.0.0:

python gen2.py -d ./output -v v2.0.0

And finally for both manual and automatic parts after generating HTML output use this command to generate your custom Dash DocSet:

cd to_your_generated_html_directory
dashing build

Credits

This code uses some of the functionalities of gen_tf_docset by Reuben Morais. I thank the author for his efforts.

License

gen2.py issue: "ValueError: not enough values to unpack (expected 2, got 1)"

Hi,

Thanks a lot for your great work. It helps a lot.

When I tried to follow the instructions to generate DocSet, it seemed that it cannot be executed under Python 3.8.
The execution error is attached to this message, please check it.
Could u help me with this issue?

Thanks in advance.

Best,

Shuyue

Error Message:

~/Desktop/dash-tf-docset(master*) » python gen2.py -d ./output -v v2.0.0                                                                           2 ↵

########################################################################
#                      Installing tensorflow-docs                      #
########################################################################

run_task: pip freeze
170B [00:00, 293B/s]  
Traceback (most recent call last):
  File "gen2.py", line 26, in <module>
    main(args.dir_path, args.version)
  File "gen2.py", line 7, in main
    tf_auto_doc_setup.run()
  File "/Users/shuyuej/Desktop/dash-tf-docset/src/tf_auto_doc_setup.py", line 189, in run
    status = self._install_tf_doc()
  File "/Users/shuyuej/Desktop/dash-tf-docset/src/tf_auto_doc_setup.py", line 127, in _install_tf_doc
    if not search_package('tensorflow_docs', None):
  File "/Users/shuyuej/Desktop/dash-tf-docset/src/utils.py", line 76, in search_package
    packages = pip_get_all_packages()
  File "/Users/shuyuej/Desktop/dash-tf-docset/src/utils.py", line 71, in pip_get_all_packages
    pkgs = [(pkg.lower().replace('-', '_'), version) for pkg, version in pkgs]
  File "/Users/shuyuej/Desktop/dash-tf-docset/src/utils.py", line 71, in <listcomp>
    pkgs = [(pkg.lower().replace('-', '_'), version) for pkg, version in pkgs]
ValueError: not enough values to unpack (expected 2, got 1)

m3hrdadfi / dash-tf-docset Goto Github PK

dash-tf-docset's Introduction

dash-tf-docset

Installation:

Supported versions/Pre-requisites.

Usage:

Manual

Automatically

Credits

License

dash-tf-docset's People

Contributors

Stargazers

Watchers

Forkers

dash-tf-docset's Issues

gen2.py issue: "ValueError: not enough values to unpack (expected 2, got 1)"

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent