Cannot properly configure autogen.py about keras-autodoc

[gabrieldemarmiesse]

Do you have an error message? If so can you post it too? I believe your problem is just configuring the imports correctly.

[ccamara]

Sure! I get the following warning:

WARNING - A relative path to 'functions_bcn_trees.md' is included in the 'nav' configuration, which is not found in the documentation files

The file is not generated, and yes, I believe you are right, but I have no clue on how to configure imports correctly. Could you please help me with that?

[gabrieldemarmiesse]

Sure. You should add a simple setup.py at the root of your project and install your project with "pip install -e ./" you can take a look at the repo keras-autodoc if you want details about what to put and where. El sáb., 21 dic. 2019 13:18, Carlos Cámara <[email protected]> escribió:

…

Sure! I get the following warning: WARNING - A relative path to 'functions_bcn_trees.md' is included in the 'nav' configuration, which is not found in the documentation files The file is not generated, and yes, I believe you are right, but I have no clue on how to configure imports correctly. Could you please help me with that? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#68?email_source=notifications&email_token=ADCLMK5Q2K25NRH3U62LE43QZYCRVA5CNFSM4J6GK5X2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHO3CQQ#issuecomment-568176962>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADCLMK4P6YISVSFH5XPRNOLQZYCRVANCNFSM4J6GK5XQ> .

[ccamara]

Thanks again!
Apologies again, but since I have just landed to python, I am not yet familiar with importing and installing projects. That's what I've done so far:

1. create a /setup.py file in my root folder. Since I am not familiar with it, I left the default contents generated by Cookiecutter DataScience:

from setuptools import find_packages, setup

setup(
    name='src',
    packages=find_packages(),
    version='0.1.0',
    description='Scripts for preparing data improrts to OSM.',
    author='Carlos Cámara',
    license='MIT',
)

2. Run pip install -e ./:

Obtaining file:///home/ccamara/www/osm_imports_preparations
Installing collected packages: src
  Running setup.py develop for src
Successfully installed src

3. Edit autogen.py with the following content:

# content of docs/autogen.py

from keras_autodoc import DocumentationGenerator

from src.features import bcn_trees



pages = {
    'api_bcn_trees.md': [
        'src.data_download',
        'src.data_munging']
    }

doc_generator = DocumentationGenerator(pages)
doc_generator.generate('./sources')

4. Run mkdocs serve, but unfortunately, nofunctions_bcn_trees.md file is generated:

$ mkdocs serve
INFO    -  Building documentation... 
INFO    -  Cleaning site directory 
WARNING -  A relative path to 'functions_bcn_trees.md' is included in the 'nav' configuration, which is not found in the documentation files 
[I 191221 14:07:15 server:296] Serving on http://127.0.0.1:8000
[I 191221 14:07:15 handlers:62] Start watching changes
[I 191221 14:07:15 handlers:64] Start detecting changes
[I 191221 14:07:49 watcher:104] Running task: builder (delay: None)
INFO    -  Building documentation... 

What am I missing?

[gabrieldemarmiesse]

in pages, try to change src.data_download by src.features.bcn_trees.data_download.
Also remember to execute the autogen.py before doing mkdocs serve.

[ccamara]

Oh! thank you! After changing the path in pages and making sure to run autogen.py before mkdocs serve (I thought that that command triggered autogen.py, but I was wrong, so thanks for pointing this out), it is working great! Thanks for your great job and for guiding me with this issue! (I have credited you in the repo following the all-contributors guidelines: https://github.com/ccamara/osm_imports_preparations#contributors-)