Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using portay with multiple namespace projects #51

Open
markab1018 opened this issue Nov 20, 2019 · 1 comment
Open

Using portay with multiple namespace projects #51

markab1018 opened this issue Nov 20, 2019 · 1 comment
Labels
bug Something isn't working

Comments

@markab1018
Copy link

Hello Timothy,

I have a namespace project that spans multiple repositories and I am trying to get portray to render the documentation for all projects in a single instance. I have tried a few different methods, and gone through the documentation, but I can't seem to find anything that works.

My (stripped down) project layout is as follows:

 .
 ├── git_repo_1
 │   ├── namespace
 │   │   ├── __init__.py
 │   │   └── foo
 │   │       ├── __init__.py
 │   │       └── foo.py
 │   ├── README
 │   └── setup.py
 ├── git_repo_2
 │   ├── namespace
 │   │   ├── __init__.py
 │   │   └── bar
 │   │       ├── __init__.py
 │   │       └── bar.py
 │   ├── README
 │   └── setup.py
 └── documentation_repo
     ├── docs
     │   └── some_doc.md
     ├── README
     └── setup.py # editable install of `git_repo_1` and `git_repo_2`

I can run portray in any of the individual repositories and generate documentation. However, this means that I have three different sites; one for each git repo. It is difficult to see what all is actually contained in namespace between namespace.foo and namespace.bar, as well as all namespace-wide documentation in documentation_repo. Do you know if what I am trying to do can be done? If not do you think Portray could be expanded to do this?

@jay-tyler
Copy link

This appears to be a bug in pdocs, and I've opened a PR here to try to fix it timothycrosley/pdocs#8.

Pends some additional unittests and review, but hopefully we can get it merged soonish.

@timothycrosley timothycrosley added the bug Something isn't working label Aug 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants