Is your feature request related to a problem? Please describe.
In my company, we have a project Foo, in which we build the documentation with mkdocs and mkdocstrings. The generated site and objects.inv is then pushed to a private GitHub repository to publish the documentation on a private site through GitHub Pages.
Now we are trying to build the documentation for another project Bar, which has references to objects in Foo, however, since the inventory file for Foo is placed in a private repo, it cannot be downloaded as part of mkdocs build.
Describe the solution you'd like
It would be great to have some way to be able to either pass credentials and/or have them be read from e.g. environment variables or .netrc when downloading inventory files.
Describe alternatives you've considered
Manually downloading the inventory file(s) and pointing to the local file path in mkdocs.yml when building the documentation. This becomes a real hassle when dealing with a team of developers having to manually download multiple inventory files and changing mkdocs.yml to point to their local file system.
We are really happy with mkdocstrings, this is just the missing piece for us 🙂
Is your feature request related to a problem? Please describe.
In my company, we have a project
Foo, in which we build the documentation withmkdocsandmkdocstrings. The generated site andobjects.invis then pushed to a private GitHub repository to publish the documentation on a private site through GitHub Pages.Now we are trying to build the documentation for another project
Bar, which has references to objects inFoo, however, since the inventory file forFoois placed in a private repo, it cannot be downloaded as part ofmkdocs build.Describe the solution you'd like
It would be great to have some way to be able to either pass credentials and/or have them be read from e.g. environment variables or
.netrcwhen downloading inventory files.Describe alternatives you've considered
Manually downloading the inventory file(s) and pointing to the local file path in
mkdocs.ymlwhen building the documentation. This becomes a real hassle when dealing with a team of developers having to manually download multiple inventory files and changingmkdocs.ymlto point to their local file system.We are really happy with
mkdocstrings, this is just the missing piece for us 🙂