Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Set up docs directory like other repos #23

Merged
merged 3 commits into from
Apr 27, 2020

Conversation

daniellimws
Copy link
Contributor

@daniellimws daniellimws commented Apr 26, 2020

  • Add Makefile and conf.py to test documentation locally
  • Add environment.yml and requirements.txt to set up conda through make env
  • Include specification.rst in index.rst so that it shows up in readthedocs

Close #19

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

- Add Makefile and conf.py to test documentation locally
- Add environment.yml and requirements.txt to set up conda
  through `make env`
- Include specification.rst in index.rst so that it shows up in
  readthedocs

Signed-off-by: Daniel Lim Wee Soong <weesoong.lim@gmail.com>
Signed-off-by: Daniel Lim Wee Soong <weesoong.lim@gmail.com>
@mithro
Copy link
Contributor

mithro commented Apr 26, 2020

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.

Signed-off-by: Daniel Lim Wee Soong <weesoong.lim@gmail.com>
@daniellimws
Copy link
Contributor Author

Fixed travis

@mithro mithro merged commit 0b5723c into chipsalliance:master Apr 27, 2020
@mithro
Copy link
Contributor

mithro commented Apr 27, 2020

@daniellimws - This seems to cause readthedocs to fail? 0b5723c

@daniellimws
Copy link
Contributor Author

daniellimws commented Apr 27, 2020

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?

@mithro
Copy link
Contributor

mithro commented Apr 27, 2020

Seems like you missed the .readthedocs.yml -- I added it in #24

@mithro
Copy link
Contributor

mithro commented Apr 27, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

FASM readthedocs is broken
2 participants