Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • Oct 23 06:47
    sanzoghenzo commented #96
  • Oct 23 01:15
    maresb commented #96
  • Oct 22 00:03
    whophil commented #96
  • Sep 11 15:47
    dkmiller opened #99
  • Aug 06 16:28
    maresb commented #53
  • Jul 26 15:36
    nikitabarskov edited #98
  • Jul 26 15:35
    nikitabarskov opened #98
  • Jul 14 15:22
    ARBaart commented #77
  • Jul 14 14:27
    ARBaart commented #77
  • Jul 14 14:23
    ARBaart commented #77
  • May 26 16:10
    kjhosein opened #97
  • Apr 20 23:05
    maresb opened #96
  • Apr 20 19:37
    maresb opened #95
  • Apr 20 19:27
    maresb commented #53
  • Apr 16 21:11
    SamGuay opened #94
  • Mar 31 21:08
    CzJLee opened #93
  • Mar 24 19:11
    kjhosein opened #92
  • Mar 22 14:26
    kchason opened #91
  • Mar 13 03:25
    JacobHayes commented #89
  • Feb 18 12:47
    garfieldnate edited #88
Or Carmi
@liiight
hi there. just stumbled into portray and it looks great!
unfortunately i cant seem to get it working. seems i get a 404 when running it
Ors-MacBook-Pro-2:notifiers orcarmi$ portray in_browser
/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/pdoc/__init__.py:223: UserWarning: Couldn't get/parse source of '<Module 'notifiers.utils'>'
  warn("Couldn't get/parse source of '{!r}'".format(doc_obj))
/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/pdoc/__init__.py:223: UserWarning: Couldn't get/parse source of '<Module 'notifiers.utils.schema'>'
  warn("Couldn't get/parse source of '{!r}'".format(doc_obj))
/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/yaml/constructor.py:126: DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it wi
ll stop working
  if not isinstance(key, collections.Hashable):
/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/mkdocs/structure/pages.py:253: DeprecationWarning: Using the add method to register a processor or pattern is deprecated. Use the `register` method instead.
  md.treeprocessors.add("relpath", relpath, "_end")
/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/markdown/core.py:128: DeprecationWarning: The 'md_globals' parameter of 'mkdocs.structure.pages._RelativePathExtension.extendMarkdown' is deprecated.
  ext._extendMarkdown(self)
/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/jinja2/lexer.py:587: DeprecationWarning: invalid escape sequence '\s'
  .decode('unicode-escape')


██████╗  ██████╗ ██████╗ ████████╗██████╗  █████╗ ██╗   ██╗
██╔══██╗██╔═══██╗██╔══██╗╚══██╔══╝██╔══██╗██╔══██╗╚██╗ ██╔╝
██████╔╝██║   ██║██████╔╝   ██║   ██████╔╝███████║ ╚████╔╝
██╔═══╝ ██║   ██║██╔══██╗   ██║   ██╔══██╗██╔══██║  ╚██╔╝
██║     ╚██████╔╝██║  ██║   ██║   ██║  ██║██║  ██║   ██║
╚═╝      ╚═════╝ ╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝   ╚═╝

        Your Project with Great Documentation.

Version: 1.0.5
Copyright Timothy Edmund Crosley 2019 MIT License


Serving on 127.0.0.1:8000...
127.0.0.1 - - [27/Aug/2019 23:02:40] "GET / HTTP/1.1" 404 0
Timothy Edmund Crosley
@timothycrosley
Hi @liiight I created a ticket for that issue here: timothycrosley/portray#17
And resolved it in the latest portray release (1.1.0)
Tejas Shetty
@TejasAvinashShetty
just discovered portray. How does it compare to readthedocs, doctr
?
Timothy Edmund Crosley
@timothycrosley
portray is no configuration documentation, it's meant to the least effort way to get a documentation website for a standard Python project.
Unlike many other documentation tools in the Python eco-system, including I believe those mentioned, its focus is on Markdown instead of RST. But primarily the difference is simply in it's laser focus on given decent documentation websites with no / minimal extra work on the developer.
Tejas Shetty
@TejasAvinashShetty
Thanks @timothycrosley
Ryan
@orcephrye
is there any way to figure out why Portray cannot find a module or errors out trying to build docs?
Ryan
@orcephrye
Ok I figured out why it was failing... It was a mistake in the spelling. sigh
However, I cannot get the 'output_dir' to be obeyed when using as_html... is that a bug?