search

NASA-PDS / deep-archive

PDS Open Archival Information System (OAIS) utilities, including Submission Information Package (SIP) and Archive Information Package (AIP) generators
https://nasa-pds.github.io/deep-archive/
Other
7 stars 4 forks source link

Update docs to use RTD #108

Closed jordanpadams closed 3 years ago

jordanpadams commented 3 years ago

updates include:

jordanpadams commented 3 years ago

@nutjob4life can you take a look at this and update so that it works 😟 . i somehow had a build/docs/Makefile to generate the docs, but then ran make clean and it disappeared and i forget what I need to do in order to get it back to generate the docs.

nutjob4life commented 3 years ago

@jordanpadams this worked for me:

$ sw_vers
ProductName:    macOS
ProductVersion: 11.3.1
BuildVersion:   20E241
$ python --version
Python 3.9.2
$ cd /tmp
$ git clone git@github.com:NASA-PDS/pds-deep-archive.git
$ cd pds-deep-archive
gh pr checkout 108
Switched to a new branch 'doc_updates'
$ python3 -m venv venv
$ venv/bin/pip install --quiet setuptools==51.3.3
$ venv/bin/python3 bootstrap.py --allow-site-packages
$ bin/buildout
$ bin/docbuilder
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] usage/index                                                                                    
generating indices... genindex
writing additional pages... search
copying images... [100%] _static/images/fs-vs-registry.png                                                              
copying static files... WARNING: logo file 'images/PDS_Planets.png' does not exist
done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 1 warning.

The HTML pages are in html.

The bin/docbuilder script just does cd build/docs; make html so the Makefile definitely gets regenerated.

jordanpadams commented 3 years ago

thanks @nutjob4life . i couldn't get it to work in my environment but that is fine. i will create another ticket to retrofit this repo per the new template repo.

jordanpadams commented 3 years ago

@nutjob4life could you actually take a look at the generated docs and make sure the logo and diagram actually appear correctly? looks like the logo I specified in the conf.py may be an incorrect path

nutjob4life commented 3 years ago

@jordanpadams will do!