chipsalliance / fasm

FPGA Assembly (FASM) Parser and Generator
https://fasm.readthedocs.io
Apache License 2.0
90 stars 30 forks source link

docs: Set up docs directory like other repos #23

Closed daniellimws closed 4 years ago

daniellimws commented 4 years ago

Close #19

Signed-off-by: Daniel Lim Wee Soong weesoong.lim@gmail.com

mithro commented 4 years ago

Look like this is causing travis to fail?

py34 run-test-pre: PYTHONHASHSEED='1816414488'
py34 run-test: commands[0] | check-manifest --ignore 'tox.ini,tests*'
lists of files in version control and sdist do not match!
missing from sdist:
  docs/Makefile
  docs/_static
  docs/_static/.keepme
  docs/conf.py
  docs/environment.yml
  docs/requirements.txt
suggested MANIFEST.in rules:
  recursive-include docs *.keepme
  recursive-include docs *.py
  recursive-include docs *.txt
  recursive-include docs *.yml
  recursive-include docs Makefile
ERROR: InvocationError for command /home/travis/build/SymbiFlow/fasm/.tox/py34/bin/check-manifest --ignore 'tox.ini,tests*' (exited with code 1)
___________________________________ summary ____________________________________
ERROR:   py34: commands failed
The command "tox" exited with 1.
daniellimws commented 4 years ago

Fixed travis

mithro commented 4 years ago

@daniellimws - This seems to cause readthedocs to fail? https://github.com/SymbiFlow/fasm/commit/0b5723cc8b5fe8c263e84652e67b17cdf186bf97

daniellimws commented 4 years ago

It seems that virtualenv is used to generate the docs instead of conda https://readthedocs.org/projects/fasm/builds/10920233/

Is it a setting that needs to be changed on readthedocs?

fasm | Read the Docs
mithro commented 4 years ago

Seems like you missed the .readthedocs.yml -- I added it in https://github.com/SymbiFlow/fasm/pull/24

mithro commented 4 years ago

Seems like this is failing now with;

Running Sphinx v2.4.4
fatal: --unshallow on a complete repository does not make sense
make: Circular links <- links dependency dropped.