search

alces-software / flight-appliance-docs

Documentation for deploying and using Alces Flight Appliances
2 stars 3 forks source link

Fix docs build warnings #18

Closed vlj91 closed 6 years ago

vlj91 commented 8 years ago

There are quite a lot of warnings when building the documentation, we should either get rid of unused pages or do something with them. Current output: 

Running Sphinx v1.3.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 41 source files that are out of date
updating environment: 41 added, 0 changed, 0 removed
reading sources... [ 60%] getting-started/environment-usage/gridware-howto/working-with-gridware-reading sources... [ 63%] getting-started/environment-usage/gridware-howto/working-with-gridware-reading sources... [ 75%] getting-started/environment-usage/using-openfoam-with-alces-flight-compreading sources... [100%] sge/sge
/Users/vlj/alces/git/flight-appliance-docs/docs/source/about/alces-flight-compute.rst:14: ERROR: Unknown target name: "alces flight application manager appliance".
/Users/vlj/alces/git/flight-appliance-docs/docs/source/about/alces-flight-galaxy-appliance.rst:11: WARNING: Bullet list ends without a blank line; unexpected unindent.
/Users/vlj/alces/git/flight-appliance-docs/docs/source/about/alces-flight-galaxy-appliance.rst:14: WARNING: Bullet list ends without a blank line; unexpected unindent.
/Users/vlj/alces/git/flight-appliance-docs/docs/source/about/alces-flight-galaxy-appliance.rst:17: WARNING: Bullet list ends without a blank line; unexpected unindent.
/Users/vlj/alces/git/flight-appliance-docs/docs/source/clusterware-storage/alces-storage-file-usage.rst:4: WARNING: Title underline too short.

Alces Storage File Storage Usage
========================
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/galaxy/run-a-fastq-galaxy-job.rst:22: WARNING: Enumerated list ends without a blank line; unexpected unindent.
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/galaxy/run-a-fastq-galaxy-job.rst:24: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/galaxy/run-a-fastq-galaxy-job.rst:47: WARNING: Enumerated list ends without a blank line; unexpected unindent.
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/galaxy/run-a-fastq-galaxy-job.rst:50: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/run-a-graphical-application.rst:None: WARNING: image file not readable: getting-started/environment-usage/_images/HPC-GraphicalDesktop.png
/Users/vlj/alces/git/flight-appliance-docs/docs/source/index.rst:44: WARNING: toctree contains reference to nonexisting document u'environment-usage/alces-storage-examples'
/Users/vlj/alces/git/flight-appliance-docs/docs/source/index.rst:44: WARNING: toctree contains reference to nonexisting document u'environment-usage/alces-storage-examples'
/Users/vlj/alces/git/flight-appliance-docs/docs/source/index.rst:44: WARNING: toctree contains reference to nonexisting document u'environment-usage/alces-storage-examples'
/Users/vlj/alces/git/flight-appliance-docs/docs/source/launch-aws/instance-types.rst:8: ERROR: Malformed table.
No bottom table border found or no blank line after table bottom.

======================================== ============================ ======================== ========================
Flight Compute CloudFormation identifier Number of cores per instance Memory per instance (GB) Share of 10GbE networking
======================================== ============================ ======================== ========================
/Users/vlj/alces/git/flight-appliance-docs/docs/source/launch-aws/instance-types.rst:11: WARNING: Blank line required after table.
/Users/vlj/alces/git/flight-appliance-docs/docs/source/overview/whatisit.rst:45: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/Users/vlj/alces/git/flight-appliance-docs/docs/source/sge/sge.rst:491: WARNING: Bullet list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/vlj/alces/git/flight-appliance-docs/docs/source/about/alces-flight-application-manager.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/about/alces-flight-compute.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/about/alces-flight-galaxy-appliance.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/about/alces-flight-storage-access.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/about/overview.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/clusterware-storage/alces-storage-file-config.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/clusterware-storage/alces-storage-file-usage.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/clusterware-storage/alces-storage-object-config.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/clusterware-storage/alces-storage-object-usage.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/clusterware-storage/alces-storage-overview.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/alces-storage-examples.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/environment_usage.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/galaxy/run-a-basic-galaxy-job.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/galaxy/run-a-fastq-galaxy-job.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/run-a-graphical-application.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/run-an-interactive-application.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/run-an-mpi-job.rst:: WARNING: document isn't included in any toctree
/Users/vlj/alces/git/flight-appliance-docs/docs/source/getting-started/environment-usage/run-storage-benchmarks.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [ 60%] getting-started/environment-usage/gridware-howto/working-with-gridware-awriting output... [ 63%] getting-started/environment-usage/gridware-howto/working-with-gridware-dwriting output... [ 75%] getting-started/environment-usage/using-openfoam-with-alces-flight-compuwriting output... [100%] sge/sge
/Users/vlj/alces/git/flight-appliance-docs/docs/source/clusterware-storage/alces-storage-file-config.rst:11: WARNING: undefined label: deployment (if the link has no caption the label must precede a section header)
/Users/vlj/alces/git/flight-appliance-docs/docs/source/clusterware-storage/alces-storage-object-config.rst:11: WARNING: undefined label: deployment (if the link has no caption the label must precede a section header)
generating indices... genindex
writing additional pages... search
copying images... [100%] getting-started/environment-usage/../../_images/paraFoam.png
copying static files... WARNING: html_static_path entry u'/Users/vlj/alces/git/flight-appliance-docs/docs/source/_static' does not exist
done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 38 warnings.

Build finished. The HTML pages are in build/html.
wdm78 commented 8 years ago

I'd like to keep the unused pages in for now - we can rationalise at a later date

ColonelPanicks commented 6 years ago

Docs were tidied up as of 2017.1 which removed undefined labels, unlinked/unused pages and any other little formatting tweaks - for removed files see https://github.com/alces-software/flight-appliance-docs/issues/66#issuecomment-305827227