by

Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • Sep 21 22:10
    andrew-schweitzer-analog commented #50
  • Sep 21 21:11
    tbsexton commented #50
  • Sep 17 08:13
    sanzoghenzo commented #52
  • Sep 15 13:59
    tbsexton commented #52
  • Aug 27 10:25
    timothycrosley labeled #30
  • Aug 27 10:25
    timothycrosley labeled #36
  • Aug 27 10:24
    timothycrosley labeled #51
  • Aug 27 10:24
    timothycrosley labeled #48
  • Aug 27 10:24
    timothycrosley labeled #53
  • Aug 27 10:23
    timothycrosley labeled #52
  • Aug 27 10:23
    timothycrosley commented #60
  • Aug 27 10:22

    timothycrosley on 60

    (compare)

  • Aug 27 10:22

    timothycrosley on master

    Resolve #60: portray in_browser… Merge pull request #61 from tim… (compare)

  • Aug 27 10:22
    timothycrosley closed #61
  • Aug 27 10:22
    timothycrosley closed #60
  • Aug 27 10:22
    timothycrosley opened #61
  • Aug 27 10:21

    timothycrosley on 60

    Resolve #60: portray in_browser… (compare)

  • Aug 27 10:08
    timothycrosley labeled #60
  • Aug 26 14:47
    giovanism commented #13
  • Aug 25 03:17
    kylebarron opened #60
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