lava-nc/lava-docs

Documentation source for Lava

lava-docs's Issues

First coding example does not work

The first coding example contains several issues.

• lif and dense are referenced as self.lif and self.dense
• SimpleRunConfig is not imported
• If SimpleRunConfig is replaced with RunConfig, which is imported, errors occur

Anticipating issue with clean_init and tutorial/ move in other lava modules

With the init cleanup fix on other lava moudles and imminent move of tutorial/ in lava to root, the make build will break.

Paths to tutorials on the 'Getting Started' page are incorrect after directory restructure of core lava repo

Update Lava-dl description

Broken links in lava API documentation on lava-nc.org

The API documentation of lava cannot be accessed from some pages, in particular the home page. It is accessible, for instance, from pages of the Lava DL API documentation.

Better separation between documentations

It would be great so separate the documentations into their own repositories. That way, the owners of the libraries such as lava-dnf and lava-optimization would have complete control over their documentation. We then could pull in those documentations in each release.

Automate lava docs

As a user I would like the documents to build and upload to lava-nc.org after a new merge to the lave-docs repository.

Remove redundant link from index.rst

Remove "For more information, visit the Lava Documentation: https://lava-nc.github.io/" from index.rst as its redundant and confusing.

lava-nc.org shows up as 'Lava Software Framework — Lava documentation (lava-nc.org)'

Description of links to lava-nc.org show up as Lava Software Framework — Lava documentation (lava-nc.org)

• Links should show up as Lava Software Framework (lava-nc.org)
• "We want there to be a short single sentence statement what Lava is and perhaps some useful sub links like tensorflow in google searches"
• SEO needs to be done for lava-nc.org

Error generating documentation

Traceback (most recent call last):
File "/lava/.pybuilder/plugins/cpython-3.8.11.final.0/lib/python3.8/site-packages/sphinx/cmd/build.py", line 276, in build_main
app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
File "/lava/.pybuilder/plugins/cpython-3.8.11.final.0/lib/python3.8/site-packages/sphinx/application.py", line 216, in init
self.config = Config.read(self.confdir, confoverrides or {}, self.tags)
File "/lava/.pybuilder/plugins/cpython-3.8.11.final.0/lib/python3.8/site-packages/sphinx/config.py", line 170, in read
raise ConfigError(__("config directory doesn't contain a conf.py file (%s)") %
sphinx.errors.ConfigError: config directory doesn't contain a conf.py file (/lava/docs)

Configuration error:
config directory doesn't contain a conf.py file (~/lava/docs)

Addressing Typos in Developer Guide

Docstring is misspelled several times through out the Developer Guide