Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.47 KB

TROUBLESHOOTING.md

File metadata and controls

32 lines (22 loc) · 1.47 KB
Raw

Troubleshooting / FAQ Guide

As common issues or questions are encountered solutions will be added to this guide.

NoProjectFound

portray raises this exception when it cant find a project in the current directory. This means that there is no pyproject.toml or setup.py file in the directory you ran portray AND that you haven't specified modules to include on the command line.

Solution 1: Go to root of project

If you do have a pyproject.toml or setup.py file in your project, chances are you simply accidentally ran portray from a different directory. Simply changing back to your projects root directory at the same level as these files should be enough to resolve your issue.

Solution 2: Create a pyproject.toml file

You can create a simplified pyproject.toml file that explicitly specifies what modules are included in your project:

[tool.portray]
modules = ["MY_MODULE"]

Solution 3: Specify the modules manually from the command line

Every CLI command supports explicitly setting one or more modules using -m:

<script id="asciicast-264805" src="https://asciinema.org/a/264805.js" async></script>

Deploying to Netlify

portray includes a built-in command to deploy to Github Pages but it's also compatible with every static website host, including the popular Netflify. There's a great guide on how to set this up contributed by @sw-yx here.