casact / pcdm Goto Github PK

Running into this error. I may have it setup wrong on my side. My assumption is it should be working out of the box.

This is really great by the way! Thank you for doing it! Cant wait to use it

I am new to this project and was trying to see if I could generate the documentation using the make.bat. I have been unsuccessful. I have Sphinx v5.0.1 installed. When I run make.bat singlehtml (or html) I get the following output:

Running Sphinx v5.0.1
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
building [singlehtml]: all documents
updating environment: [new config] 0 added, 0 changed, 0 removed

Sphinx error:
root file C:\xxx\xxx\PCDM\docs\index.rst not found

It appears I am missing an index.rst file but I am not sure where I would get that file. Any thoughts?

In the README, can we put in a hyperlink and also a tiny bit of background about what SQL Alchemy is?

Also, can we put in a bit of sample code and output to illustrate some of the key tables and schema? The illustration is helpful, but I'm not fully able to interpret it. For example, it doesn't look like an object-relational model. Having something which shows primary and foreign keys would be very informative.

Not sure if that second paragraph is on point as I'm not 100% sure what SQL Alchemy does. :-)