Overview

Update to build and publish docs

Fixes Known Issues

N\A

Documentation

All of them

Testing

Ensure that build didn't break and we can build docs.

Manual

Manually verify that they build

Automated

Regression suite and ensure docs are build as part of automation.

Additional Information

N\A

neomonkeus commented 6 years ago

@TagnumElite Lots of warning I missed from #47 WARNING: No type for element 'init_as_null': falling back to xs:anyType. WARNING: No type for element 'init_as_target': falling back to xs:anyType. WARNING: No type for element 'fx_profile_abstract': falling back to xs:anyType. WARNING: No type for element 'fx_profile_abstract': falling back to xs:anyType. WARNING: No type for element 'gl_hook_abstract': falling back to xs:anyType. WARNING: No type for element 'gl_hook_abstract': falling back to xs:anyType. /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: invalid signature for autoclass ('pyffi.formats.nif::NifFormat.ns keyarray') /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: don't know which module to import for autodocumenting 'pyffi.formats.nif::NifFormat.ns keyarray' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: invalid signature for autoclass ('pyffi.formats.nif::NifFormat.ns keylin') /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: don't know which module to import for autodocumenting 'pyffi.formats.nif::NifFormat.ns keylin' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: invalid signature for autoclass ('pyffi.formats.nif::NifFormat.ns keyrotarray') /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: don't know which module to import for autodocumenting 'pyffi.formats.nif::NifFormat.ns keyrotarray' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: invalid signature for autoclass ('pyffi.formats.nif::NifFormat.ns keyrotsub') /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: don't know which module to import for autodocumenting 'pyffi.formats.nif::NifFormat.ns keyrotsub' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: invalid signature for autoclass ('pyffi.formats.nif::NifFormat.ns keytan') /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: don't know which module to import for autodocumenting 'pyffi.formats.nif::NifFormat.ns keytan' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: invalid signature for autoclass ('pyffi.formats.nif::NifFormat.ns keytbc') /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: don't know which module to import for autodocumenting 'pyffi.formats.nif::NifFormat.ns keytbc' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: invalid signature for autoclass ('pyffi.formats.nif::NifFormat.ns keyvecarray') /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: don't know which module to import for autodocumenting 'pyffi.formats.nif::NifFormat.ns keyvecarray' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: invalid signature for autoclass ('pyffi.formats.nif::NifFormat.ns keyvecarraytyp') /home/travis/build/niftools/pyffi/docs/pyffi/formats/nif.rst:10: WARNING: don't know which module to import for autodocumenting 'pyffi.formats.nif::NifFormat.ns keyvecarraytyp' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.BSShaderTextureSet:0: WARNING: Inline strong start-string without end-string. /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.BSShaderType:0: WARNING: Inline strong start-string without end-string. /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.HavokColFilter.layer:0: WARNING: Inline strong start-string without end-string. /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.NiAlphaProperty.threshold:0: WARNING: Inline strong start-string without end-string. /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.NiFogProperty.fog_color:0: WARNING: Inline strong start-string without end-string. /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.NiParticles:0: WARNING: Inline strong start-string without end-string. /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.NiStencilProperty.pass_action:0: WARNING: Inline strong start-string without end-string. /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.NiTimeController.frequency:0: WARNING: Inline strong start-string without end-string. /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.NiVertexColorProperty.lighting_mode:0: WARNING: Inline strong start-string without end-string. /home/travis/build/niftools/pyffi/pyffi/formats/nif/__init__.py:docstring of pyffi.formats.nif.NifFormat.bhkRagdollTemplateData.friction:0: WARNING: Inline strong start-string without end-string.

TagnumElite commented 6 years ago

There were even more warnings that was fixed when I did this. Undo that and see even more errors. Same problem with the NifFormat.ns * stuff. Python doesn't like spaces between names, doing this to the rest of the _Meta classes would fix that problem from happening but once the nif.xml is updated which has those keys removed it won't be problem. Otherwise those errors were always there even before my PR, doesn't cause the build to fail just stops the item from being documented.

coveralls commented 6 years ago

Coverage remained the same at 58.373% when pulling b2972b27a8a92ec05c1f7fa9da0f64f24ded99fa on neomonkeus:docs/update_ghpage_branch into 7f61cc2f40d8896efd4135564bd7e77f903c2315 on niftools:develop.