portray
portray copied to clipboard
Using portay with multiple namespace projects
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?
This appears to be a bug in pdocs, and I've opened a PR here to try to fix it https://github.com/timothycrosley/pdocs/pull/8.
Pends some additional unittests and review, but hopefully we can get it merged soonish.